Skip to main content
GET
List an organization's PIX refunds
Only organization admins can list the whole organization’s refunds.

Headers

x-environment
enum<string>

Environment of the refunds: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; 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 whose refunds to list.

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 the wallet's PIX refunds.

items
object[]
required

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

"NjcxMGQyZTRiNGQzZTgwMDEyYzlhMWY3"