Skip to main content
GET
List an organization's boleto charges
Filter by status, which takes its values comma-separated (?status=CREATED,PAID), and page with limit + next. Any other query parameter filters by the exact value of that field of the charge (comma-separated values match any of them, so a value can’t itself contain a comma) — for example ?walletId=… or ?customer.document=11222333000181. Charges of the other environment are not listed, so send x-environment: LIVE for production charges. 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 charges; 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

Query Parameters

status
string[]

Only charges in these statuses (case-insensitive). A charge is usually CREATED (payable), PAID or CANCELED; it can also be INITIATED, REQUESTED, ENQUEUED, PROCESSING, PROCESSING_PAYMENT or ERROR. Other values match no charge.


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

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 charges.

items
object[]
required

The charges 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:

"NjcyN2MzZDRiNGQzZTgwMDEyYzliNWMy"