Skip to main content
POST
Cancel a Pix Automatic charge
A charge already sent to the payer’s bank — SCHEDULED, or one the bank is still processing — is canceled there first, which is no longer possible on or after its date; one never sent is only marked. Either way it moves to CANCELED. Only CREATED and SCHEDULED charges can be canceled, and the first payment only once the payer has granted the authorization: before that it goes with the authorization itself, so cancel the authorization instead. Other refusals by the payment institution carry its own status and code. 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 authorization: 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 receives the payments (24 hexadecimal characters), or default for the organization's main wallet.

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

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

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

ID of the charge — its _id in the authorization's schedules (24 hexadecimal characters).

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

Response

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