Skip to main content
POST
Cancel a Pix payment
A payment can be cancelled while it is REQUESTED, waiting for approval (PENDING_APPROVAL — its approval request is cancelled too) or SCHEDULED (its schedule is cancelled too). Cancelling a payment that is already CANCELLED succeeds again and changes nothing. Send no body. You need the same permission as to pay from the wallet: on the organization’s main wallet, be an organization admin; on another wallet, be an organization admin or have it shared with you as OWNER or USER — and Pix payments must be enabled in its settings.

Headers

x-environment
enum<string>

Environment of the payment: 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 that pays (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 payment — its _id (24 hexadecimal characters).

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

Response

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