Skip to main content
GET
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string
obrigatório

UUID da conta associada à operação.

Exemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Parâmetros de consulta

txId
string

BCB transaction ID — routes to by-txId lookup

Exemplo:

"T1234567890123456789012345A"

page
string

Page number (1-based, default 1)

Exemplo:

"1"

limit
string

Rows per page (default 20, max 100)

Exemplo:

"20"

status
string

Filter by status

Exemplo:

"ACTIVE"

keyValue
string

Filter by Pix key value (exact match)

dueDateFrom
string

Filter: due date range start (YYYY-MM-DD)

Exemplo:

"2026-08-01"

dueDateTo
string

Filter: due date range end (YYYY-MM-DD)

Exemplo:

"2026-08-31"

Resposta

List envelope in list mode, or a single DueDateCollectionOutput when txId is supplied.

items
object[] | null
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

20

page
integer<int64>
obrigatório
Exemplo:

1

total
integer<int64>
obrigatório
Exemplo:

1