Skip to main content
POST
Cancel a Pix Automatic authorization
The authorization moves to CANCELED, and so do its charges still CREATED or SCHEDULED — the ones already sent to the payer’s bank are canceled there first; paid, failed and expired charges keep their status. A charge already sent to the payer’s bank can’t be canceled on or after its date. Canceling an authorization that is already CANCELED, REVOKED or EXPIRED changes nothing and also answers 204. While the payer is in the middle of granting it, it can’t be canceled: try again in a few minutes. If canceling one of its charges at the payer’s bank fails, the authorization is already CANCELED and the answer is that failure; that charge keeps its status, and calling again answers 204 without retrying it. Check schedules with GET .../pix-billing-automatic/{pixBillingAutomaticId}. 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}$

Response

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