Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Payment Authorizations (Brazil)

Cancel a Payment Authorization

{% admonition type="warning" name="Coming Soon" %} This endpoint is currently undergoing development.. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

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" %} The latest you can cancel a Payment Authorization is by 22:00:00 (GMT-3) on the day before the next Charge date. If you miss the cutoff time, the Payment Authorization will be cancelled, but the Charge will still be processed. {% /admonition %}

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

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, then you must send through this header set to Payments-BR.V2.

{% admonition type="warning" name="Coming Soon" %} This version is in Coming Soon. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

Response

No content