Skip to main content
GET
Listar agendamentos Pix

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

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de consulta

status
enum<string>

Filtrar por status do agendamento

Opções disponíveis:
SCHEDULED,
PROCESSING,
EXECUTED,
FAILED,
CANCELLED
limit
integer
padrão:10

Número máximo de itens por página.

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

Número da página para paginação.

Intervalo obrigatório: x >= 1

Resposta

OK

items
object[]

Items contém os registros de agendamento da página atual.

limit
integer

Limit é o número máximo de itens por página.

Exemplo:

10

page
integer

Page é o número da página atual (começando em 1).

Exemplo:

1

total
integer

Total é a contagem total de agendamentos que correspondem ao filtro, em todas as páginas, restrita ao X-Account-Id de quem faz a chamada.

Exemplo:

42