Skip to main content
GET
List a wallet's boleto payments
Filter by status, which takes its values comma-separated (?status=PAID,FAILED), and page with limit + next. Any other query parameter filters by the exact value of that field of the payment — for example ?type=UTILITY_BILL. Payments of the other environment are not listed, so send x-environment: LIVE for production payments. A payment waiting for approval whose deadline passed is listed as EXPIRED. 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 payments you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST payments; 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 (24 hexadecimal characters), or default for the organization's main wallet.

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

Query Parameters

status
string[]

Only payments in these statuses (case-insensitive): REQUESTED, PENDING_APPROVAL, EXPIRED, SCHEDULED, PAID, FAILED, CANCELLED or REFUNDED. PENDING_APPROVAL leaves out payments whose approval deadline passed, which EXPIRED includes. Other values match no payment.


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

Maximum string length: 64
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 boleto payments.

items
object[]
required

The payments of this page, newest first.

next
string | null
required

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

Example:

"NjcyNmIxYzJiNGQzZTgwMDEyYzlhNGEx"