Skip to main content
GET
List Pix Schedules

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Account-Id
string
obrigatório

Unique identifier of the Midaz Ledger Account (UUID format).

Parâmetros de consulta

status
enum<string>

Filter by schedule status

Opções disponíveis:
SCHEDULED,
PROCESSING,
EXECUTED,
FAILED,
CANCELLED
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

Resposta

OK

items
object[]

Items contains the schedule rows for the current page.

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 schedules matching the filter, across all pages, scoped to the caller's X-Account-Id.

Exemplo:

42