proof com os detalhes da operação.
Use o extrato para conciliação, auditoria e para localizar uma transação específica, como o Pix original de uma devolução.
Listar transações por período
Parâmetros de query
Período disponível
O extrato da API cobre os últimos 6 meses, contados a partir do primeiro dia do mês. UmstartDate anterior a esse limite retorna 400 com a data mínima aceita:
Buscar uma transação específica
Informe um destes parâmetros para buscar uma única transação. Nesse caso, o filtro de período não é necessário.cURL
O
id da transação é diferente do endToEndId do Pix. Para buscar pelo identificador do Pix, use o parâmetro endToEndId.Paginação
A resposta é um array de transações. Os dados de paginação vêm no headerPagination:
Header
Para percorrer o período inteiro, incremente
page até chegar a pageCount.
Um
limit acima de 50 é reduzido para 50 sem erro. Confira o pageSize do header antes de calcular as páginas.Campos da transação
O objeto proof
O proof traz os dados da operação que gerou o lançamento. Em um Pix, ele tem o endToEndId, o status e os dados de pagador e recebedor, como no exemplo acima. Em um pagamento de boleto, traz os dados do boleto pago.
Trate o proof como um objeto que varia por tipo: leia os campos de acordo com o type.name da transação.
O
proof do extrato é um JSON com os dados da operação. Para o comprovante oficial em PDF de um Pix, use o endpoint de comprovante.Tipos de transação
Os tipos mais comuns em uma integração via API:
O extrato também pode trazer lançamentos operacionais, como bloqueios judiciais, tarifas e ajustes. Use
type.isCredit para classificar qualquer tipo como entrada ou saída, mesmo os que não estão na tabela.
Erros comuns
Referência da API
Consultar extrato
GET /baas/api/v2/transactions
