Pular para o conteúdo principal
GET
List boletos

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Organization-Id
string

Midaz organization whose boletos are listed. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Only boletos of this organization are listed and counted.

Parâmetros de consulta

status
enum<string>

Status filter.

Opções disponíveis:
PENDING,
CREATED,
SETTLED,
CANCELED,
INACTIVATED,
FAILED
Exemplo:

"CREATED"

kind
enum<string>

Boleto kind filter.

Opções disponíveis:
SINGLE,
INSTALLMENT
Exemplo:

"SINGLE"

type
enum<string>

Boleto type filter.

Opções disponíveis:
TRADITIONAL,
QR_CODE,
HYBRID
Exemplo:

"TRADITIONAL"

from
string

Created-from bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and starts at its first instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T00:00:00-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
Exemplo:

"2026-01-01"

to
string

Created-to bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and covers it to its last instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T23:59:59.999999-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
Exemplo:

"2026-12-31"

dueDateFrom
string<date>

Due-date lower bound, inclusive.

Exemplo:

"2026-02-01"

dueDateTo
string<date>

Due-date upper bound, inclusive.

Exemplo:

"2026-11-30"

page
integer<int64>
padrão:1

Page number, one-based.

Intervalo obrigatório: x >= 1
Exemplo:

1

limit
integer<int64>
padrão:20

Items per page.

Intervalo obrigatório: 1 <= x <= 100
Exemplo:

20

Resposta

OK

items
object[] | null
obrigatório
limit
integer<int64>
obrigatório
page
integer<int64>
obrigatório
total
integer<int64>
obrigatório