Consultar transações EDI

GET/edi/transactions

Atualizado em 21 de março de 2025 · 2 min de leitura

Retorna transações pagas ou estornadas em um período.

Retorna transações pagas ou estornadas dentro de um período. O período máximo de consulta é de 3 meses.

GEThttps://{apiUrl}/edi/transactions

URL base da API

Token de autenticação

Query Params

begin_datestringrequired

Data inicial (yyyy-mm-dd)

end_datestringrequired

Data final (yyyy-mm-dd)

pageintegeroptional

Número da página (padrão: 1)

payment_methodstringoptional

Filtrar por método: credit_card, pix, boleto

statusstringoptional

Filtrar por status: paid, refunded

curl --request GET \
  --url "https://{apiUrl}/edi/transactions"

Response

Choose an example:

application/json

Parâmetros

Query

Parâmetro	Tipo	Obrigatório	Descrição
`begin_date`	string	Sim	Data inicial (`yyyy-mm-dd`)
`end_date`	string	Sim	Data final (`yyyy-mm-dd`)
`page`	integer	Não	Número da página (padrão: `1`)
`payment_method`	string	Não	Filtrar por método: `credit_card`, `pix`, `boleto`
`status`	string	Não	Filtrar por status: `paid`, `refunded`

Headers

Parâmetro	Tipo	Obrigatório	Descrição
`Authorization`	string	Sim	Chave privada no formato `Bearer {token}`

Limite: O intervalo entre begin_date e end_date não pode exceder 3 meses.

Exemplo de requisição

bash

curl --request GET \
  --url 'https://{apiUrl}/edi/transactions?begin_date=2025-01-01&end_date=2025-03-31&status=paid' \
  --header 'Authorization: Bearer {token}'

Responses

Esta página foi útil?