Servicio de consulta de Preautorización
En caso de falla de comunicación o demora excesiva en la respuesta (timeout) en alguna de las operaciones que siguen al beginTransaction, la tienda debe consumir obligatoriamente la operación getStatus. Esta operación permite verificar el status de una solicitud a la que el comerciante no obtuvo respuesta, recuperando los parámetros que no pudo recibir en el flujo normal.
La tienda debe recuperar el Status de la transacción (con un plazo máximo de consulta de 15 días) si tiene el nit, a través del webservice getStatus, pasando como parámetro la clave de autenticación de la tienda (merchantKey) y el nit.
Desarrollo/Certificación: si no ha recibido la merchantKey para el desarrollo/certificación, solicite la misma por email autorizadores5317@softwareexpress.com.br o por teléfono +55 (11) 3170-5317.
Producción: la merchantKey para Producción será enviada por el equipo de Portal Carat de Producción; si no se recibe después de los procedimientos debidos para ingresar a Producción, por favor, solicite el e-mail esitef.prod6773@softwareexpress.com.br.
Tenga en cuenta que, en casos excepcionales, la clave de autenticación (merchantKey) se puede cambiar por razones de seguridad, sin embargo, el equipo de producción se comunicará con la tienda antes del cambio.
Recuerde que hay varios factores que pueden causar un retraso en la respuesta, como la inestabilidad de Internet y el host de la red que autoriza la tarjeta. Recomendamos que el servidor de la tienda tenga un tiempo de espera igual o superior a 90 segundos.
Nota: Este servicio solo devolverá datos si la transacción se realizó a través de Web Services, no funcionará en caso de transacciones a través de la interfaz HTML.
Atención : La consulta de la transacción de Portal Carat NO consulta el Status de la transacción en el adquirente / autorizador . Este servicio devuelve el status de la transacción en la base de datos de Portal Carat.
Ejemplo: Si una operación de preautorización se confirma en Portal Carat pero se anula por teléfono directamente con la entidad adquirente/autorizadora, esta anulación no se reflejará necesariamente en el Servicio de Consulta de Operaciones de Portal Carat.
Detalles de la llamada#
Recurso :
/ 1/transactions/ {nit}Método HTTP :
GETFormato de solicitud :
JSONFormato de respuesta :
JSONParámetros de encabezado:
| Nombre del parámetro | Descripción | Tamaño | Obligatorio |
|---|---|---|---|
Content-Type | Valor establecido "application/json" | = 15 A | Sí |
merchant_id | Código de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes | ||
merchant_key | Clave de autenticación para la tienda de Portal Carat. Las claves de producción y certificación serán diferentes. | ≤ 80 A | Sí |
nit | Identificador de transacción de Portal Carat. Se obtiene del retorno de la llamada beginTransaction. | = 64 A | Sí |
Parámetros de solicitud#
En la URL del recurso se debe enviar el nit.
| Nombre del parámetro | Descripción | Tamaño | Obligatorio |
|---|---|---|---|
nit | Identificador de transacción de Portal Carat. Se obtiene del retorno de la llamada beginTransaction. | = 64 A | Sí |
La llamada de la operación de consulta de la transacción - getStatus - no requiere un cuerpo de solicitud.
Parámetros de respuesta#
| Nombre del parámetro | Descripción | Tamaño |
|---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" significa que la consulta falló. Para obtener más información, consulte el documento Anexo A-2 - Códigos de respuesta. | < 4 N |
message | Mensaje de respuesta de Portal Carat de la consulta. | < 500 AN |
acquirer_id | Código del adquirente/enrutamiento utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente/enrutamiento utilizado en la transacción. | < 100 AN |
amount | Importe de la compra especificado por la tienda (en centavos) al momento de la creación de la transacción. | < 12 AN |
authorization_number | Numero de autorización. | < 6 AN |
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_date | Fecha efectiva de la preautorización devuelta por el autorizador en el formato DD/MM/AAAA’T’HH:mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
authorizer_id | Código da autorizadora utilizada na transação. | < 4 N |
authorizer_merchant_id | Código de afiliação do lojista na autorizadora. | < 100 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
customer_receipt | Cupón (vía cliente). | < 4000 AN |
eci | Eletronic Commerce Indicator (indicador del nivel de seguridad de la transacción de preautorización a través de Cielo e-Commerce). | < 3 AN |
esitef_usn | Número secuencial único de la transacción de preautorización del Portal Carat. | = 15 N |
host_usn | Autorizador NSU. | < 15 AN |
issuer | Código de marcas de tarjeta devuelto por el autorizador. | < 5 AN |
merchant_receipt | Cupón (vía establecimiento). | < 4000 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 AN |
nit | Identificador de la transacción de preautorización en Portal Carat. | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
payment_type | Tipo de pago del autorizador elegido: B = boleto, C = crédito, D = débito, P = tarjeta de crédito Private Label pura, T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago, W = Boleto NR vía Web Service | = 1 A |
sitef_usn | Número secuencial único de la transacción de preautorización en SiTef. | = 6 N |
status | Status de la transacción de preautorización en Portal Carat. | = 3 AN |
tid | ID de la transacción en la entidad adquirente/enrutamiento. Este campo sólo se devuelve en las transacciones con adquirentes externos a SiTef. | < 40 AN |
xid | El campo XID devuelto en las autenticaciones 3DS o en ciertas adquisiciones/enrutamientos. | < 40 AN |
acquirer_id | Código adquiriente/enrutamiento utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente/enrutamiento utilizado en la transacción. | < 100 AN |
amount | Importe de la compra especificado por la tienda (en centavos) al momento de la creación de la transacción. | < 12 AN |
authorization_number | Número de autorización. | < 6 AN |
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_date | Fecha efectiva de la preautorización retornada por el autorizador en el formato DD/MM/AAAA'T'HH:mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
authorizer_id | Código de autorización utilizado en la transacción. | < 4 N |
authorizer_merchant_id | Código de afiliación del comerciante en el autorizador. | < 100 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
customer_receipt | Cupón (vía cliente). | < 4000 AN |
eci | Eletronic Commerce Indicator (indicador del nivel de seguridad de la transacción de preautorización a través de Cielo e-Commerce). | < 3 AN |
esitef_usn | Número secuencial único de la transacción de preautorización en Portal Carat. | = 15 N |
host_usn | Autorizador NSU. | < 15 AN |
issuer | Código de marcas de tarjeta devuelto por el autorizador. | < 5 AN |
merchant_receipt | Cupón (vía establecimiento). | < 4000 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 AN |
nit | Identificador de la transacción de preautorización en Portal Carat. | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
payment_type | Tipo de pago del autorizador elegido: B = boleto, C = crédito, D = débito, P = tarjeta de crédito Private Label pura, T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago, W = Boleto NR vía Web Service | = 1 A |
sitef_usn | Número secuencial único de la transacción de preautorización en SiTef. | = 6 N |
status | Status de la transacción de preautorización en Portal Carat. | = 3 AN |
tid | ID de transacción en adquirente/enrutamiento. Este campo sólo se devuelve en las transacciones con adquirentes externos a SiTef. | < 40 AN |
xid | Campo XID devuelto en autenticaciones 3DS o ciertos adquirientes/enrutamientos. | < 40 AN |
| pre_authorization.analysis | ||
code | Código de respuesta de la operación de análisis de fraude en preautorización. | < 4 N |
message | Mensaje de respuesta de la operación de análisis de fraude en preautorización. | < 200 AN |
status | Status de transacción de análisis de fraude en preautorización. Este campo puede tomar los siguientes valores: NOV - Nuevo. EXP - Caducado. ACC - Aceptado REJ - Rechazado REV - En revisión INV - No válido | = 3 AN |
Atención : Los campos
codeymessagese refieren al código y al mensaje que hace referencia a la solicitud de consulta. Estos no se refieren a las transacciones consultadas.
Ejemplo#
Solicitud:
Respuesta:
Códigos de respuesta
Ver referencia en Códigos API - Códigos de respuesta
Consulta de transacción en un grupo de tiendas#
El Portal Carat requiere que las credenciales (merchant_id ymerchant_key) sean las mismas que se usaron en la transacción que se va a consultar. Sin embargo, si el comerciante lo necesita, Portal Carat puede permitir consultas con credenciales de otras tiendas del mismo grupo. Para hacer esto, solo solicite a nuestros equipos de soporte y producción que realicen este lanzamiento.