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 Portal 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: Existe un plazo máximo de 15 días para consultar el estado de la transacción. Después de este período, el identificador de transacción (nit) se invalida.
La consulta de transacción en el Portal 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 Portal 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:
Consulta por SID#
- Recurso:
/v1/schedules/{sid} - 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:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Consulta de programación#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Consulta por NIT de pago con cita previa#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Consulta por SID de pago con sita previa#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
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 Portal Carat. Cualquier código que no sea 0 significa error. Sepa mas. | < 4 N |
message | Mensaje de respuesta de Portal 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 Portal Carat. Sepa mas. | = 3 AN |
nit | Identificador de la transacción de pago en Portal 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 Portal Carat. | = 15 N |
customer_receipt | Cupón (vía cliente). | < 4000 AN |
merchant_receipt | Cupón (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 |
eci | Eletronic Commerce Indicator (iindicador del nivel de seguridad de la transacción de pago). | < 3 AN |
payment_date | Fecha efectiva del pago en el Portal 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 |
xid | Campo XID devuelto en autenticaciones 3DS o ciertos adquirentes. | < 40 AN |
balance | Saldo disponible después del pago con tarjetas tipo Gift. | < 12 N |
| payment.analysis | ||
code | Código de respuesta de la operación de análisis de fraude. | < 4 N |
message | Mensaje de respuesta de la operación de análisis de fraude. | < 200 AN |
status | Status de transacción de análisis de fraude de Portal Carat. 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 |
| schedule | ||
status | Status de programación en Portal Carat. Sepa mas. | = 3 AN |
sid | Identificador de la transacción de reserva en Portal Carat. | = 64 AN |
schedule_usn | Número secuencial único del Portal Carat. | = 15 N |
authorizer_id | Código de autorización que se utilizará en pagos programados. | = 4 N |
amount | Monto de los pagos programados especificados por la tienda (en centavos) al crear la transacción. | < 12 N |
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 |
initial_date | Fecha de ejecución del primer pago programado en el formato DD/MM/AAAA. | = 10 D |
next_date | Fecha de ejecución del próximo pago programado en el formato DD/MM/AAAA. | = 10 D |
number_of_times | Número total de pagos programados. | < 3 N |
current_times | Número de pagos programados ya ejecutados. | < 3 N |
installments | Número de cuotas que se utilizarán para los pagos programados. | < 2 N |
installment_type | Tipo de financiación que se utilizará para los pagos programados. | < 2 N |
soft_descriptor | Texto adicional que aparecerá con el nombre del establecimiento en el extracto de la tarjeta de crédito del comprador. | < 30 AN |
show_times_invoice | Para las programaciones de tiempo finito, si este campo tiene un valor true, añada al final del campo soft_descriptor el número de ejecuciones/total de ejecuciones (ejemplo: Firma 3/12). | < 5 T/F |
nits | NITs de los últimos seis pagos programados ya ejecutados. | = 64 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 Portal Carat. Sepa mas. | = 3 AN |
nit | Número de identificación de la transacción de cancelación en el Portal 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 Portal Carat. | = 15 N |
customer_receipt | Cupón (vía cliente). | < 4000 AN |
merchant_receipt | Cupón (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 | Data de efetivação do cancelamento no Pagamento Online no formato DD/MM/AAAA'T'HH:mm. Exemplo: 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 |
is_host_cancel | Este campo devolverá el valor true en caso de cancelación a través del host. | < 5 T/F |
terminal_id | Código de terminal utilizado en la transacción | < 8 AN |
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 esta liberiación.