Skip to main content
GET
List a wallet's PIX refunds
Each refund sends a received PIX payment back to whoever sent it, in full or in part. Page with limit + next. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for production wallets. Organization admins can list every wallet’s refunds; other users only those of the wallets shared with them, in any role.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST reversals; 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 the wallet belongs to.

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

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"