Consulta por order_id

Estes serviço pode ser chamado para obter os dados da transação de pagamento ou cancelamento. É essencial o uso dessa operação em casos de erro de comunicação para verificar o status atual da transação, que pode ter sido efetuada ou não recebida pelo Carat.

Atenção:

A consulta de transação no Carat NÃO efetua uma consulta do status da transação no adquirente / autorizador. Este serviço retorna o status da transação na base de dados do Carat.

Exemplo: Caso uma transação de pagamento seja confirmada no Carat, mas seja estornada via telefone diretamente no adquirente / autorizador, este estorno não será necessariamente refletido no serviço de consulta de transação do Carat.

Detalhes da chamada#

  • Recurso: /v2/transactions/?order_id={order_id}
  • Método HTTP: GET
  • Formato da requisição: query string
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.< 80 ANSIM
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM

Exemplos#

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl --location --request GET 'https://{{url}}/e-sitef/api/v2/transactions?order_id=1234567890&page=0&limit=10' \
--header 'Content-Type: application/json' \
--header 'merchant_id: *********' \
--header 'merchant_key: *********'
--verbose

Resposta em caso de sucesso com um 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": "229",
"acquirer_name": "Bin",
"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"
}

Resposta em caso de sucesso com dois ou mais 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": "229",
"acquirer_name": "Bin",
"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": "229",
"acquirer_name": "Bin",
"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"
}

Resposta em caso de pedido não encontrado:

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

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de efetivação de pagamento:

ParâmetroDescriçãoFormato
codeCódigo de resposta do Carat. Qualquer código diferente de 0 significa falha. Saiba mais.< 4 N
messageMensagem de resposta do Carat.< 500 AN
current_pagePáginal atual da pesquisa< 2 N
total_pagesNúmero total de páginas< 2 N
countContagem da páginas< 2 N
transactions[].payment
authorizer_codeCódigo de resposta do autorizador.< 10 AN
authorizer_messageMensagem de resposta do autorizador.< 500 AN
statusStatus da transação de pagamento no Carat. Saiba mais.= 3 AN
nitIdentificador da transação de pagamento no Carat.= 64 AN
order_idCódigo de pedido enviado pela loja na criação da transação.< 40 AN
merchant_usnNúmero sequencial único enviado pela loja na criação da transação.< 12 N
amountValor da compra especificado pela loja (em centavos) na criação da transação.< 12 N
sitef_usnNúmero sequencial único da transação de pagamento no SiTef.= 6 N
esitef_usnNúmero sequencial único da transação de pagamento no Carat.= 15 N
customer_receiptCupom (via cliente).< 4000 AN
merchant_receiptCupom (via estabelecimento).< 4000 AN
authorizer_idCódigo da autorizadora utilizada na transação.< 4 N
acquirer_idCódigo do adquirente utilizado na transação.< 4 N
acquirer_nameNome do adquirente utilizado na transação.< 100 AN
authorizer_dateData de efetivação do pagamento retornada pelo autorizador no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
authorization_numberNúmero de autorização.< 6 AN
host_usnNSU da autorizadora.< 15 AN
payment_dateData de efetivação do pagamento no Carat no formato DD/MM/AAAA'T'HH:mm. Exemplo: 13/07/2017T16:03= 16 D
issuerCódigo da bandeira retornado pelo autorizador.< 5 AN
authorizer_merchant_idCódigo de afiliação do lojista na autorizadora.< 100 AN
terminal_idCódigo do terminal utilizada na transação< 8 AN
installmentsNúmero de parcelas a ser utilizado nos pagamentos agendados.< 2 N