Payment Authorizations (Brazil)

Cancel a Payment Authorization

Cancel a Payment Authorization

We respond with a 204 - No Content and will inform you via webhook that the Payment Authorization was canceled successfully.

{% admonition type="warning" name="Cancellation Time Restrictions (Pix Automático)" %} For Pix Automático Payment Authorizations, the latest you can cancel a Payment Authorization is by 22:00:00 (GMT-3) on the day before the next Charge date. This restriction doesn't apply to Smart Transfers (see below). If you miss the cutoff time, the Payment Authorization will be cancelled, but the Charge will still be processed. {% /admonition %}

{% admonition type="info" name="Smart Transfers" %} You can cancel a Smart Transfers (PIX_OF_SMART_TRANSFERS) Payment Authorization only while its status is AUTHORIZED. Otherwise, you receive a 400 error. After you cancel it, the status changes to REVOKED asynchronously: wait for the PAYMENT_AUTHORIZATION webhook (or check the authorization) to confirm it. {% /admonition %}

post/payments/br/payment-authorizations/{payment_authorization_id}/cancel/

Request

Path parameters

payment_authorization_idstring uuid required
Example:a3b92311-1888-449f-acaa-49ae28d68fcd

The scheduled payment-authorization.id you want to cancel.

Headers

X-Belvo-API-Resource-Version'Payments-BR.V2'
Example:Payments-BR.V2

Header indicating which version of the Payment API you want to use. Currently this is only applicable for Bank Accounts, Customers, and Payment Authorizations in Brazil. In the case that you are using our Payment Authorizations product (including Smart Transfers authorizations and their Charges), then you must send through this header set to Payments-BR.V2.

Response

No content

Changes

No recorded changes to this operation across all 5 revisions of this API.