Skip to main content
GET
List scheduled Pix payments

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

limit
integer<int64>

Page size, 1..100. Absent means 20. A value outside that range is REFUSED, never clamped and never silently coerced -- a clamped page size makes a caller believe it read everything.

Exemplo:

20

cursor
string

Opaque cursor from a previous page's pagination block. Echo it verbatim -- it is not a document to build.

account_id
string

Narrow to one payer account.

status
enum<string>

Narrow to one lifecycle status.

Opções disponíveis:
PENDING,
EXECUTING,
DISPATCHED_OUTCOME_UNKNOWN,
AWAITING_RETRY,
SETTLED,
CANCELLED,
FAILED
start_date
string<date>

Earliest settlement date to include, inclusive.

Exemplo:

"2026-09-01"

end_date
string<date>

Latest settlement date to include, inclusive.

Exemplo:

"2026-09-30"

Resposta

OK

items
object[] | null
obrigatório

The page, newest settlement date first. Never null.

nextCursor
string

Pass back as cursor for the following page. Absent on the last page -- its absence is how the listing ends, not an empty items array.