Serviço de consulta de múltiplas transações
Estes serviços podem ser chamados para obter os dados de múltiplas transações para uma loja ou grupo da loja. É essencial o uso dessa operação em casos de erro de comunicação para verificar o status atual de transações, que podem ter sido efetuada ou não recebida pelo e-SiTef.
Atenção:
A consulta de transações no e-SiTef NÃO efetua uma consulta do status da transações no adquirente / autorizador. Este serviço retorna o status da transação na base de dados do e-SiTef.
Exemplo: Caso uma transação de pagamento seja confirmada no e-SiTef, 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 e-SiTef.
Detalhes da chamada
- Recurso:
/v1/transactions - Método HTTP:
GET - Formato da requisição: query string
- Formato da resposta:
JSON - Parâmetros de cabeçalho:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
merchant_id | Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes. | < 80 AN | SIM |
group_id | Código do grupo de loja no e-SiTef. Caso seja enviado, será feito uma busca pelo grupo da loja. É necessário que o código da loja esteja dentro do grupo. | < 38 N | NÃO |
- Parâmetros de requisição:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
start_date | Data inicial das transações a serem listadas. Formato: dd/MM/aaaa | = 10 AN | SIM |
end_date | Data final das transações a serem listadas. Período máximo: 5 dias (configurável). Formato: dd/MM/aaaa | = 10 AN | SIM |
status | Filtro de status de transações. Ex.: "CON" | = 3 N | NÃO |
page | Página da listagem. A primeira página tem valor "0". Caso não seja enviada, assumiremos o valor "0". | < 1000 N | NÃO |
limit | Número máximo de registros por página. Caso não seja enviado, assumiremos o valor máximo 1000 de transações por vez (configurável). | < 4 N | NÃO |
payment_link | Filtro para indicar a busca por transações de pagamento por link. Apenas ativo no caso de valor true | < 5 T/F | NÃO |
Exemplos
Abaixo estão alguns exemplos de chamada dos serviços de consulta utilizando a ferramenta cURL.
Consulta de múltiplas transações
Requisição:
curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions?start_date=25/11/2020&end_date=27/11/2020&status=CON&page=0&limit=50"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "group_id: 12345"
--verbose
Resposta:
{
"code":"0",
"message":"OK. Transaction successful.",
"current_page":"0",
"total_pages":"1",
"count":"2",
"transactions":[
{
"type":"P",
"authorizer_code":"000",
"authorizer_message":"Transacao OK",
"status":"CON",
"nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id":"13064421440",
"customer_receipt":"==== CUPOM COMPRADOR ====",
"merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
"authorizer_id":"2",
"acquirer_id":"1005",
"acquirer_name":"Redecard",
"authorizer_date":"13/07/2017T18:44",
"authorization_number":"132048",
"merchant_usn":"13064421441",
"esitef_usn":"170713097341620",
"sitef_usn":"132048",
"host_usn":"999132048 ",
"payment_date":"13/07/2017T18:44",
"amount":"1000",
"payment_type":"C",
"issuer":"2",
"authorizer_merchant_id":"000000000000005",
"merchant_id": "xxxxxxxxxxxxxxx",
"creation_date": "13/07/2017T18:43",
"installments": "1"
},
{
"type":"F",
"authorizer_code":"000",
"authorizer_message":"Transacao OK",
"status":"CON",
"nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
"order_id":"13064421440",
"customer_receipt":"==== CUPOM COMPRADOR ====",
"merchant_receipt":"==== CUPOM ESTABELECIMENTO ====",
"authorizer_id":"2",
"acquirer_id":"1005",
"acquirer_name":"Redecard",
"authorizer_date":"13/07/2017T18:44",
"authorization_number":"132048",
"merchant_usn":"13064421441",
"esitef_usn":"170713097341620",
"sitef_usn":"132048",
"host_usn":"999132048 ",
"payment_date":"13/07/2017T18:44",
"amount":"1000",
"payment_type":"C",
"issuer":"2",
"authorizer_merchant_id":"000000000000005",
"merchant_id": "xxxxxxxxxxxxxxx",
"creation_date": "13/07/2017T18:42",
"installments": "3"
}
]
}
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 consulta de múltiplas transações:
| Parâmetro | Descrição | Formato | |
|---|---|---|---|
code | Código de resposta do e-SiTef. Qualquer código diferente de 0 significa falha. Saiba mais. | < 4 N | |
message | Mensagem de resposta do e-SiTef. | < 500 AN | |
current_page | Página atual dos registros. | < 4 N | |
total_pages | Número total de páginas. | < 4 N | |
count | Contagem total de registros. | < 4 N | |
| transactions[] | Lista de transações encontradas para os filtros selecionados. Retornaremos apenas os campos em comum entre os vários tipos de transação, além do novo campo "type", que explicita qual é o tipo da transação. | ||
type | Tipo da transação. G = Captura de Pré-Autorização, A = Consulta AVS, E = Estorno, P = Pagamento, F = Pré-Autorização, R = Recarga | < 1 A | |
authorizer_code | Código de resposta do autorizador. | < 10 AN | |
authorizer_message | Mensagem de resposta do autorizador. | < 500 AN | |
status | Status da transação de pagamento no e-SiTef. Saiba mais. | = 3 AN | |
nit | Identificador da transação de pagamento no e-SiTef. | = 64 AN | |
merchant_id | Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes. | < 15 AN | |
order_id | Código de pedido enviado pela loja na criação da transação. | < 40 AN | |
merchant_usn | Número sequencial único enviado pela loja na criação da transação. | < 12 N | |
amount | Valor da compra especificado pela loja (em centavos) na criação da transação. | < 12 N | |
sitef_usn | Número sequencial único da transação de pagamento no SiTef. | = 6 N | |
esitef_usn | Número sequencial único da transação de pagamento no e-SiTef. | = 15 N | |
customer_receipt | Cupom (via cliente). | < 4000 AN | |
merchant_receipt | Cupom (via estabelecimento). | < 4000 AN | |
authorizer_id | Código da autorizadora utilizada na transação. | < 4 N | |
acquirer_id | Código do adquirente utilizado na transação. | < 4 N | |
acquirer_name | Nome do adquirente utilizado na transação. | < 100 AN | |
authorizer_date | Data de efetivação do pagamento retornada pelo autorizador no formato dd/MM/aaaa'T'HH:mm. Exemplo: 13/07/2017T16:03 | = 16 D | |
authorization_number | Número de autorização. | < 6 AN | |
host_usn | NSU da autorizadora. | < 15 AN | |
tid | ID da transação no adquirente. Este campo só é retornado em transações com adquirentes externos ao SiTef. | < 40 AN | |
payment_date | Data de efetivação do pagamento no e-SiTef no formato dd/MM/aaaa'T'HH:mm. Exemplo: 13/07/2017T16:03 | = 16 D | |
issuer | Código da bandeira retornado pelo autorizador. | < 5 AN | |
authorizer_merchant_id | Código de afiliação do lojista na autorizadora. | < 100 AN | |
payment_type | Tipo do pagamento da autorizadora escolhida. Ex.: C = Crédito, D = Débito | < 1 A | |
creation_date | Data da criação da transação no e-SiTef, no formato dd/MM/aaaa'T'HH:mm. Exemplo: 13/07/2017T16:03 | = 16 D | |
installments | Número de parcelas da transação | < 2 N | |