Cancel Payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A payment with a PENDING status due to an AUTHORIZE transaction status can be canceled before it is completed if the payment is no longer required. Sending a cancel request will update the payment status to CANCELLED.

🚧

3DS Payments

Payments in a PENDING status due to 3DS authentication cannot be canceled. These payments are in a temporary state awaiting user authentication. The payment status will automatically update to either FRAUD VERIFIED or CANCELLED based on the outcome of the authentication process.

📘

Alternative Payment Methods

Alternative payment methods such as PIX also support payment cancellation with a PENDING status. Reach out to your technical account manager for more information.

If you need a receipt for the canceled transaction, you can retrieve it after it has been created. To do this, use the Retrieve Payment by ID endpoint and check the receipt_url field in the payment.transaction object. See The Payment Object for receipt, receipt_url, and receipt_language.

To use this endpoint, you have to provide an X-Idempotency-Key in your request. Check the Authentication page for more information.

Path Params
string
required

The unique identifier of the payment (UUID, 36 chars).

string
required

The unique identifier of the transaction (UUID, 36 chars).

Body Params
string

Description of the cancellation.(MAX 255; MIN 3)

string
enum

Reason for the cancellation. Values can be DUPLICATE, FRAUDULENT, and REQUESTED_BY_CUSTOMER.

Allowed:
string
required

Identification of the payment transaction defined by the merchant (MAX 255; MIN 3).

response_additional_data
object

Specifies additional data for required the transaction response

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json