Skip to main content
POST
Cancel a Pix charge
Only an ACTIVE charge with a dueDate can be canceled — a static QR code (no dueDate) can’t. It moves to CANCELED, with the moment in canceledAt. Canceling a charge that is already CANCELED changes nothing and also answers 204; a PAID charge can’t be canceled. When the payment institution throttles the request, the answer is a 429 whose code is the institution’s own reason; nothing changed — retry later. Use default as walletId for the organization’s main wallet. Any member of the organization can cancel one.

Headers

x-environment
enum<string>

Environment of the charge: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; 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 the charge belongs to (24 hexadecimal characters), or default for the organization's main wallet.

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

ID of the Pix charge — its _id (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

No Content. The operation succeeded and the response has no body.