Skip to main content
GET
List Pix Schedules

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

X-Account-Id
string
requerido

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

Parámetros de consulta

status
enum<string>

Filter by schedule status

Opciones disponibles:
SCHEDULED,
PROCESSING,
EXECUTED,
FAILED,
CANCELLED
limit
integer
predeterminado:10

Maximum number of items per page.

Rango requerido: 1 <= x <= 100
page
integer
predeterminado:1

Page number for pagination.

Rango requerido: x >= 1

Respuesta

OK

items
object[]

Items contains the schedule rows for the current page.

limit
integer

Limit is the maximum number of items per page.

Ejemplo:

10

page
integer

Page is the current page number (1-based).

Ejemplo:

1

total
integer

Total is the total count of schedules matching the filter, across all pages, scoped to the caller's X-Account-Id.

Ejemplo:

42