Skip to main content
GET
List an organization's Pix charges
Page with limit + next. Any other query parameter filters by the exact value of that field of the charge — for example ?walletId=66f2a3d1b4d3e80012c9a0d2 or ?status=PAID; a value that doesn’t fit the field (?dueDate=tomorrow) fails the request. Only the charges of the environment in x-environment are listed, so send x-environment: LIVE for production ones. 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

Query Parameters

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 Pix 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:

"NjcyYTFmNGViNGQzZTgwMDEyYzliM2U3"