Consulta

Se puede llamar a estos servicios para obtener los datos de la transacción para el pago o la anulación. En el caso de pago con cita previa, las consultas devolverán los datos de la transacción.

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 directamente al adquirente / autorizador, esta anulación no se reflejará necesariamente en el servicio de consulta de pago de Portal Carat.

Consulta por NIT

Detalles de la llamada

• Recurso: /v2/transactions/{nit}
• Método HTTP: GET
• Formato de la solicitud: no hay parámetros de solicitud
• Formato de la resposta: JSON
• Parámetros de encabezado:

Parámetro	Descripción	Formato	Obligatorio
merchant_id	Código de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes.	< 15 AN	SI
merchant_key	Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes.	< 80 AN	SI
Content-Type	Debe enviarse con el valor application / json.	= 15 AN	SI

Ejemplos

Consulta de pago

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v2/transactions/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr' \

--header 'Content-Type: application/json' \

--header 'merchant_id: **********' \

--header 'merchant_key: **********'

Respuesta en caso de pedido encontrado:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"authorizer_code": "000",

"authorizer_message": "Transacao Aprov.",

"status": "CON",

"nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",

"order_id": "1660141068187",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "10/08/2022T11:17",

"authorization_number": "105668",

"merchant_usn": "12050620649",

"esitef_usn": "220810105359590",

"sitef_usn": "105668",

"host_usn": "999105668 ",

"amount": "10000",

"payment_type": "C",

"issuer": "2",

"authorizer_merchant_id": "000000000000005",

"terminal_id": "ES000024",

"payment_date": "10/08/2022T11:17",

"installments": 10

}

}

Respuesta en caso de pedido no encontrado:

{

"code": "82",

"message": "Your transaction was not found on our system. Please, return to the site and try again.

Please, contact the website administrator if this problem occurs again."

}

Consulta de anulación

Al solicitar el servicio de anulación se creará una nueva transacción con un NIT diferente al de la transacción de pago original. Si tiene éxito, el estado de la transacción de pago cambiará a EST (invertido) y la transacción de anulación estará en estado CON (confirmado). Cada una de estas operaciones se puede consultar con sus respectivos NIT.

Transacción de pago NIT

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v2/transactions/d0eed50e34b37fd230389d618bf7bb023c02050ff9447d93d5b943e2f38117dd' \

--header 'Content-Type: application/json' \

--header 'merchant_id: **********' \

--header 'merchant_key: **********'

Respuesta:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"authorizer_code": "000",

"authorizer_message": "Transacao Aprov.",

"status": "EST",

"nit": "d0eed50e34b37fd230389d618bf7bb023c02050ff9447d93d5b943e2f38117dd",

"order_id": "1665683321507",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/10/2022T14:48",

"authorization_number": "130083",

"merchant_usn": "12050620649",

"esitef_usn": "221013109642120",

"sitef_usn": "130083",

"host_usn": "999130083 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"authorizer_merchant_id": "000000000000005",

"terminal_id": "ES000001",

"payment_date": "13/10/2022T14:48",

"installments": 10

}

}

Respuesta en caso de pedido no encontrado:

{

"code": "82",

"message": "Your transaction was not found on our system. Please, return to the site and try again.

Please, contact the website administrator if this problem occurs again."

}

Anulación transacción NIT

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/api/v2/transactions/1c1caed9c650b29832d79d4a714b5d7526573ffefc726226b073fe0235006275' \

--header 'Content-Type: application/json' \

--header 'merchant_id: **********' \

--header 'merchant_key: **********'

Respuesta:

{

"code": "0",

"message": "OK. Transaction successful.",

"cancellation": {

"authorizer_code": "000",

"status": "CON",

"nit": "1c1caed9c650b29832d79d4a714b5d7526573ffefc726226b073fe0235006275",

"order_id": "1665683321507",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/10/2022T14:49",

"authorization_number": "130083",

"merchant_usn": "12050620649",

"esitef_usn": "221013109642141",

"sitef_usn": "130084",

"host_usn": "999130084 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"terminal_id": "ES000001",

"esitef_date": "13/10/2022T14:49",

"is_host_cancel": "false"

}

}

Respuesta en caso de pedido no encontrado:

{

"code": "82",

"message": "Your transaction was not found on our system. Please, return to the site and try again.

Please, contact the website administrator if this problem occurs again."

}

Consulta por order_id

Detalles de la llamada

• Recurso: /v2/transactions/transactions?order_id={order_id}
• Método HTTP: GET
• Formato de la solicitud: query string
• Formato de la resposta: JSON
• Parámetros de encabezado:

Parámetro	Descripción	Formato	Obligatorio
merchant_id	Código de tienda en el Portal Carat. Los códigos de producción y certificación serán diferentes.	< 15 AN	SI
merchant_key	Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes.	< 80 AN	SI
Content-Type	Debe enviarse con el valor application/json.	= 15 AN	SI

Ejemplos

Consulta de pago

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v2/transactions?order_id=1663088515049&page=0&limit=7' \

--header 'Content-Type: application/json' \

--header 'merchant_id: **********' \

--header 'merchant_key: **********'

Respuesta en caso de pedido encontrado:

{

"code": "0",

"message": "OK. Transaction successful.",

"transactions": [

{

"payment": {

"authorizer_code": "000",

"authorizer_message": "Transacao Aprov.",

"status": "EST",

"nit": "b916345da34b17d6e4d81f58cbdbf67100227d253aaa26c3a04de4c1734a024e",

"order_id": "1663088515049",

"customer_receipt":"====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/09/2022T14:01",

"authorization_number": "135983",

"merchant_usn": "12050620649",

"esitef_usn": "220913107453280",

"sitef_usn": "135983",

"host_usn": "999135983 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"authorizer_merchant_id": "000000000000005",

"terminal_id": "ES000042",

"payment_date": "13/09/2022T14:01",

"installments": 10

}

},

{

"cancellation": {

"authorizer_code": "000",

"status": "CON",

"nit": "eac07d8d1fe9b64166f5c4a5fbc2a8d4fe9047be2b9d41581f891a04bb2759b9",

"order_id": "1663088515049",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/09/2022T14:02",

"authorization_number": "135983",

"merchant_usn": "12050620649",

"esitef_usn": "220913107453291",

"sitef_usn": "135984",

"host_usn": "999135984 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"terminal_id": "ES000042",

"esitef_date": "13/09/2022T14:02",

"is_host_cancel": "false"

}

}

],

"current_page": "0",

"total_pages": "1",

"count": "2"

}

Respuesta en caso de pedido no encontrado:

{

"code": "82",

"message": "Your transaction was not found on our system. Please, return to the site and try again.

Please, contact the website administrator if this problem occurs again."

}

Consulta de anulación

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v2/transactions?order_id=1663088515049&page=0&limit=7' \

--header 'Content-Type: application/json' \

--header 'merchant_id: **********' \

--header 'merchant_key: **********'

Respuesta:

{

"code": "0",

"message": "OK. Transaction successful.",

"transactions": [

{

"payment": {

"authorizer_code": "000",

"authorizer_message": "Transacao Aprov.",

"status": "EST",

"nit": "b916345da34b17d6e4d81f58cbdbf67100227d253aaa26c3a04de4c1734a024e",

"order_id": "1663088515049",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/09/2022T14:01",

"authorization_number": "135983",

"merchant_usn": "12050620649",

"esitef_usn": "220913107453280",

"sitef_usn": "135983",

"host_usn": "999135983 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"authorizer_merchant_id": "000000000000005",

"terminal_id": "ES000042",

"payment_date": "13/09/2022T14:01",

"installments": 10

}

},

{

"cancellation": {

"authorizer_code": "000",

"status": "CON",

"nit": "eac07d8d1fe9b64166f5c4a5fbc2a8d4fe9047be2b9d41581f891a04bb2759b9",

"order_id": "1663088515049",

"customer_receipt": "====CUPOM COMPRADOR====",

"merchant_receipt": "====CUPOM ESTABELECIMENTO====",

"authorizer_id": "2",

"acquirer_id": "1005",

"acquirer_name": "Redecard",

"authorizer_date": "13/09/2022T14:02",

"authorization_number": "135983",

"merchant_usn": "12050620649",

"esitef_usn": "220913107453291",

"sitef_usn": "135984",

"host_usn": "999135984 ",

"amount": "9977",

"payment_type": "C",

"issuer": "2",

"terminal_id": "ES000042",

"esitef_date": "13/09/2022T14:02",

"is_host_cancel": "false"

}

}

],

"current_page": "0",

"total_pages": "1",

"count": "2"

}

Respuesta en caso de pedido no encontrado:

{

"code": "82",

"message": "Your transaction was not found on our system. Please, return to the site and try again.

Please, contact the website administrator if this problem occurs again."

}

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 siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de realización de pagos:

Parámetro	Descripción	Formato
code	Código de respuesta de Portal Carat. Cualquier código que no sea "0" significa error. [Más información.] (Api-codes.md # response-codes)	< 4 N
message	Mensaje de respuesta de Portal Carat.	< 500 AN
current_page	Página actual de registros.	< 4 N
total_pages	Número total de páginas.	< 4 N
count	Recuento total de registros.	< 4 N
payment
authorizer_code	Código de respuesta del autorizador.	< 10 AN
authorizer_message	Mensaje de respuesta del autorizador.	< 500 AN
status	Estado de la transacción de pago en Portal Carat. Más información.	= 3 AN
nit	Identificador de la transacción de pago 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	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
sitef_usn	Número secuencial único de la transacción de pago en Pagamento Online.	= 15 N
customer_receipt	Cupón (a través del 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
adquisr_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 de vigencia del pago devuelta por el autorizador en formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 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 transacciones con adquirentes que no son SiTef.	< 40 AN
eci	Indicador de comercio electrónico (indicador del nivel de seguridad de las transacciones de pago).	< 3 AN
payment_date	Fecha de vigencia del pago en Portal Carat en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03	= 16 D
issuer	Marca el código devuelto 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
installments	Número de cuotas que se utilizarán para los pagos programados.	< 2 N
is_host_cancel	Este campo devolverá el valor true en caso de anulación a través del host.	< 5 T/F
customer_receipt	Cupón (vía cliente).	< 4000 AN
merchant_receipt	Cupón (vía establecimiento).	< 4000 AN
payment_type	Tipo de pago del autorizador elegido: B = comprobante bancario, C = crédito, D = débito, P = tarjeta de crédito de Private Label pura, T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago, W = comprobante bancario NR vía Web Service	= 1 AN
cancellation
authorizer_code	Código de respuesta del autorizador.	< 10 AN
status	Estado de la transacción de pago en Portal Carat. [Más información.] (codigos-da-api.md#status-de-transacões-do-e-sitef)	= 3 AN
nit	Identificador de la transacción de anulación 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
sitef_usn	Número secuencial único de la transacción de pago en Pagamento Online.	= 15 N
customer_receipt	Cupón (a través del 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
adquisr_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 de vigencia del pago devuelta por el autorizador en formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 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 transacciones con adquirentes que no son SiTef.	< 40 AN
eci	Indicador de comercio electrónico (indicador del nivel de seguridad de las transacciones de pago).	< 3 AN
payment_date	Fecha de vigencia del pago en Portal Carat en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03	= 16 D
issuer	Marca el código devuelto 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
installments	Número de cuotas que se utilizarán para los pagos programados.	< 2 N
is_host_cancel	Este campo devolverá el valor true en caso de anulación a través del host.	< 5 T/F
esitef_date	Fecha efectiva de anulación en el Carat en el formato DD / MM / AAAA'T'HH: mm. Ejemplo: 07/13 / 2017T16: 03	= 16 D
customer_receipt	Cupón (vía cliente).	< 4000 AN
merchant_receipt	Cupón (vía establecimiento).	< 4000 AN
payment_type	Tipo de pago del autorizador elegido: B = comprobante bancario, C = crédito, D = débito, P = tarjeta de crédito de Private Label pura, T = transferencia bancaria, G = tarjeta gift, O = otros métodos de pago, W = comprobante bancario NR vía Web Service	= 1 AN