Contexto


Neste artigo, vamos apresentar como realizar a consulta de transações por meio da nossa API. Essa funcionalidade permite recuperar detalhes de transações específicas, com suporte a filtros por período e por endToEndId. Útil em conciliações e investigações de transações específicas.


Pré-requisitos


Antes de realizar a consulta de transações, certifique-se de que:

  • Está autenticado com um token válido da nossa API;
  • Possui um client_id e client_secret ativos;
  • Já possui uma conta cadastrada.


1. Consulta de Transação por ID 


GET {{url}}/v2/accounts/{{accountId}}/transactions/{{transactionId}}


Essa chamada permite consultar diretamente uma transação específica a partir do seu identificador (transactionId). 


2. Consulta de Transações com Filtros 


{{url}}/v2/accounts/{{accountId}}/transactions?begin=2021-11-01&end=2021-11-26&endToEndId={{endToEndId}}


3. Parâmetros de Consulta


Parâmetro
Descrição
begin
Data inicial da consulta (formato YYYY-MM-DD).
end
Data final da consulta (formato YYYY-MM-DD).
endToEndId
Identificador único da transação, usado para busca precisa.


⚠️ Observações Importantes

  • Sempre utilize o intervalo de datas (begin e end) ao filtrar por endToEndId;
  • A ausência desses parâmetros pode causar a não localização da transação, mesmo que ela exista;
  • Certifique-se de que o período informado abrange a data da transação que está buscando.
  • Recomendamos o uso dessa API apenas para consulta de transações com os filtros de identificação da transação (transactionId e endToEndId). Para consulta de transações da conta em um período deve ser utilizado as APIs de extrato que são mais performáticas para a volumetria de transações.


Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte