Skip to main content
GET
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string
required

UUID of the account associated with the operation.

Example:

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

Query Parameters

txId
string

BCB transaction ID — routes to by-txId lookup

Example:

"T1234567890123456789012345A"

page
string

Page number (1-based, default 1)

Example:

"1"

limit
string

Rows per page (default 20, max 100)

Example:

"20"

status
string

Filter by status

Example:

"ACTIVE"

keyValue
string

Filter by Pix key value (exact match)

Response

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

items
object[] | null
required
limit
integer<int64>
required
Example:

20

page
integer<int64>
required
Example:

1

total
integer<int64>
required
Example:

1