Servicio de consulta de transacciones
Se puede llamar a estos servicios para obtener los datos de la transacción para el pago, la cancelación o la programación. Es fundamental utilizar esta operación en casos de error de comunicación para verificar el Status actual de la transacción, que puede o no haber sido recibida por Portal Carat.
El Carat proporciona un servicio de consulta de NIT (pago/ cancelación) y un servicio de consulta de SID (horario). En el caso de pago con agendamiento, las consultas devolverán los datos de las dos transacciones.
Atención:
La consulta de transacción en el Carat NO consulta el Staus de la transacción en el adquirente / autorizador . Este servicio devuelve el Staus de la transacción en la base de datos de Portal Carat.
Ejemplo: Si se confirma una transacción de pago en Carat, pero se revierte vía telefónica directamente al adquirente / autorizador, esta anulación no se reflejará necesariamente en el servicio de consulta de pago de Portal Carat.
Detalles de la llamada#
Consulta por NIT#
- Recurso:
/v1/transactions/{nit} - Método HTTP:
GET - Formato de solicitud: no hay parámetros de solicitud
- Formato de respuesta:
JSON - Parámetros de encabezado:
Ejemplos#
Abajo, se muestran algunos ejemplos de llamadas a servicios de consulta con la herramienta cURL.
Consulta de pago#
Solicitud:
Respuesta:
Códigos de respuesta
Ver referencia en Códigos API - Códigos de respuesta
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será 200. Cualquier otro código debe interpretarse como un error. En la tabla abajo se muestra una descripción de los parámetros de respuesta del servicio de consulta de transacciones:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Carat. Cualquier código que no sea 0 significa error. Más información. | < 4 N |
message | Mensaje de respuesta de Carat. | < 500 AN |
| payment | ||
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_message | Mensasaje de respuesta del autorizador. | < 500 AN |
status | Staus de la transacción de pago en Carat. Más información. | = 3 AN |
nit | Identificador de la transacción de pago en Carat | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 N |
amount | Importe de la compra especificado por la tienda (en centavos) al momento de la creación de la transacción. | < 12 N |
sitef_usn | Número secuencial único de la transacción de pago de SiTef. | = 6 N |
esitef_usn | Número secuencial único de la transacción de pago en Carat. | = 15 N |
customer_receipt | Recibo (vía cliente). | < 4000 AN |
merchant_receipt | Recibo (vía establecimiento). | < 4000 AN |
authorizer_id | Código de autorización utilizado en la transacción. | < 4 N |
acquirer_id | Código del adquirente utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente utilizado en la transacción. | < 100 AN |
authorizer_date | Fecha efectiva del pago devuelto por el autorizador en el formato DD/MM/AAAA'T'HH:mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
authorization_number | Numero de autorización. | < 6 AN |
host_usn | Autorizador NSU. | < 15 AN |
tid | ID de transacción en el adquirente. Este campo solo se devuelve en las transacciones con adquirentes externos a SiTef. | < 40 AN |
payment_date | Fecha efectiva del pago en el Carat en el formato DD/MM/AAAA'T'HH:mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
issuer | Código de la tarjeta devuelto por el autorizador. | < 5 AN |
authorizer_merchant_id | Código de afiliación del comerciante con la agencia autorizadora. | < 100 AN |
| cancellation | ||
authorizer_code | Código de respuesta del autorizador. | < 10 AN |
authorizer_message | Mensaje de respuesta del autorizador. | < 500 AN |
status | Status de la transacción de cancelación en Carat. Más información. | = 3 AN |
nit | Número de identificación de la transacción de cancelación en el Carat. | = 64 AN |
order_id | Código de pedido enviado por la tienda al crear la transacción. | < 40 AN |
merchant_usn | Número secuencial único enviado por la tienda al crear la transacción. | < 12 N |
amount | Monto de cancelación especificado en la tienda (en centavos). | < 12 N |
sitef_usn | Número secuencial único de la transacción de cancelación en SiTef. | = 6 N |
esitef_usn | Número secuencial único de la transacción de cancelación del Carat. | = 15 N |
customer_receipt | Recibo (vía cliente). | < 4000 AN |
merchant_receipt | Recibo (vía establecimiento). | < 4000 AN |
authorizer_id | Código de autorización utilizado en la transacción. | < 4 N |
acquirer_id | Código del adquirente utilizado en la transacción. | < 4 N |
acquirer_name | Nombre del adquirente utilizado en la transacción. | < 100 AN |
authorizer_date | Fecha efectiva de cancelación devuelta por el autorizador en formato DD/MM/YYYY'T'HH: mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
authorization_number | Numero de autorización. | < 6 AN |
host_usn | NSU del autorizador. | < 15 AN |
tid | ID de transacción en el adquirente. Este campo sólo se devuelve en las transacciones con adquirentes externos a SiTef. | < 40 AN |
esitef_date | Datos efectivos de la cancelación en el Pago Online en el formato DD/MM/AAAA'T'HH:mm. Ejemplo: 13/07/2017T16:03 | = 16 D |
issuer | Código de la marca de la tarjeta devuelta por el autorizador. | < 5 AN |
authorizer_merchant_id | Código de afiliación del comerciante con la agencia autorizadora. | < 100 AN |
terminal_id | Código de terminal utilizado en la transacción | < 8 AN |