Skip to main content
GET
List a wallet's Pix Automatic charges
Filter by due date (minDueDate, maxDueDate) and by status, which takes its values comma-separated (?status=SCHEDULED,PAID); sort with order and page with limit + next. Use it to follow what is due and what was paid. Only the charges of the environment in x-environment are listed, so send x-environment: LIVE for production ones. Use default as walletId for the organization’s main wallet. Any member of the organization can list them.

Headers

x-environment
enum<string>

Environment whose charges you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST ones; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the wallet that receives the payments (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

Query Parameters

minDueDate
string

Only charges due (scheduledTo) on or after this date: an ISO 8601 date (2026-12-01, midnight UTC) or date-time.

maxDueDate
string

Only charges due on or before this date, in the same format.

status
string[]

Only charges in these statuses (case-insensitive): CREATED, SCHEDULED, PAID, FAILED, SCHEDULE_ERROR, CANCELED, EXPIRED or RETRY. Other values match no charge.


Example (comma-separated list): ?status=SCHEDULED,PAID

Maximum string length: 64
order
enum<string>

Order of the charges by when they were created: DESC (newest first, the default) or ASC (oldest first). Case-insensitive.

Available options:
ASC,
DESC
next
string

Cursor returned as next by the previous page. Omit it for the first page.

limit
integer

Page size. Defaults to 15.

Required range: x > 0

Response

Successful response

A page of charges.

items
object[]
required

The charges of this page, in the order you asked for.

next
string | null
required

Cursor of the next page: send it as next to read it. null on the last page.

Example:

"NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Q0"