Consulta por order_id

Se puede llamar a estos servicios para obtener los datos de la transacción para el pago o la cancelació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.

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#

Recurso: /v2/transactions
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#

Solicitud:

curl --location --request GET 'https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v2/transactions?order_id=1234567890&page=0&limit=10' \
--header 'Content-Type: application/json' \
--header 'merchant_id: *********' \
--header 'merchant_key: *********'
--verbose

Respuesta exitosa con un pedido:

{
    "code": "0",
    "message": "OK",
    "transactions": [
        {
            "code": "0",
            "message": "OK. Transaction successful.",
            "payment": {
                "authorizer_code": "000",
                "authorizer_message": "Transacao Aprov.",
                "status": "CON",
                "nit": "8bea6787a4121c65dc84a6ae02330a790c7c1a2730d76fe98b81bca1a2639adc",
                "order_id": "1659445331723",
                "customer_receipt": "====CUPOM COMPRADOR====",
                "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
                "authorizer_id": "2",
                "acquirer_id": "1005",
                "acquirer_name": "Redecard",
                "authorizer_date": "02/08/2022T10:02",
                "authorization_number": "025437",
                "merchant_usn": "12050620649",
                "esitef_usn": "220802104855470",
                "sitef_usn": "025437",
                "host_usn": "999025437   ",
                "amount": "3300",
                "payment_type": "C",
                "issuer": "2",
                "authorizer_merchant_id": "000000000000005",
                "terminal_id": "ES000022",
                "payment_date": "02/08/2022T10:02",
                "installments": 10
            }
        }
    ],
    "current_page": "0",
    "total_pages": "1",
    "count": "1"
}

Respuesta exitosa con dos o más pedidos:

{
    "code": "0",
    "message": "OK",
    "transactions": [
        {
            "payment": {
                "authorizer_code": "000",
                "authorizer_message": "Transacao Aprov.",
                "status": "CON",
                "nit": "8bea6787a4121c65dc84a6ae02330a790c7c1a2730d76fe98b81bca1a2639adc",
                "order_id": "29121009973",
                "customer_receipt": "====CUPOM COMPRADOR====",
                "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
                "authorizer_id": "2",
                "acquirer_id": "1005",
                "acquirer_name": "Redecard",
                "authorizer_date": "02/08/2022T10:02",
                "authorization_number": "025437",
                "merchant_usn": "29121009973",
                "esitef_usn": "220802104855470",
                "sitef_usn": "025437",
                "host_usn": "999025437   ",
                "amount": "3300",
                "payment_type": "C",
                "issuer": "2",
                "authorizer_merchant_id": "000000000000005",
                "terminal_id": "ES000022",
                "payment_date": "02/08/2022T10:02",
                "installments": 10
            }
        },
        {
            "payment": {
                "authorizer_message": "anti-fraude=INV-Client service communication failure",
                "status": "INV",
                "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
                "order_id": "29121009973",
                "authorizer_id": "2",
                "acquirer_id": "1005",
                "acquirer_name": "Redecard",
                "merchant_usn": "29121009973",
                "esitef_usn": "220729104657020",
                "amount": "1000",
                "payment_type": "C",
                "analysis": {
                    "status": "INV",
                    "code": "0",
                    "message": "Client service communication failure"
                },
                "installments": 1
            }
        }
    ],
    "current_page": "0",
    "total_pages": "1",
    "count": "2"
}

Respuesta de orden no encontrada:

{
    "code": "1032",
    "message": "Result not found"
}

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 de búsqueda actual	< 2 N
`total_pages`	Número total de páginas	< 2 N
`count`	Recuento de páginas	< 2 N
transactions[].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.] (codigos-da-api.md#status-de-transacões-do-e-sitef)	= 3 AN
`nit`	Identificador de la transacción de pago en PayPal.	= 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 a través de Cielo e-Commerce).	< 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

Home

Detalles de la llamada#

Ejemplos#

Parámetros de respuesta#