Skip to main content
GET
List Transaction Reports

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit
integer
padrão:10

Maximum number of items per page.

Intervalo obrigatório: 1 <= x <= 100
page
integer
padrão:1

Page number for pagination.

Intervalo obrigatório: x >= 1
sort_order
enum<string>
padrão:asc

Sort direction: asc or desc.

Opções disponíveis:
asc,
desc
end_to_end_id
string

Filter by the PIX end-to-end identifier

return_identification
string

Filter by the return identification (refund reports)

initiation_type
enum<string>

Filter by initiation type; case-insensitive

Opções disponíveis:
MANUAL,
DICT,
STATIC_QRCODE,
DYNAMIC_QRCODE
status
array

Transaction statuses (comma-separated)

created_at_start
string<date-time>

Filter by reports created on or after this timestamp (RFC3339)

created_at_end
string<date-time>

Filter by reports created on or before this timestamp (RFC3339)

Resposta

OK

items
object[]

Items contains the list of transaction reports

limit
integer

Limit is the maximum number of items per page

Exemplo:

10

page
integer

Page is the current page number (1-based)

Exemplo:

1

total
integer

Total is the total count of matching items

Exemplo:

42