Cancel
/dpm/payments-gwproxy/v2/payments/cancelCancel a Payment
The Cancel endpoint allows merchants to cancel a payment, ensuring that the transaction amount is refunded to the customer. To undo a Card Present authorization that is not captured yet, use Reversal instead.
Select the example that matches your integration on the right panel:
- Credit/Debit refund — cancels a credit or debit payment. Omit
amountfor a full cancel; include it for a partial cancel (D+1 only). - Standard PIX refund — reverses a PIX payment using
payment_idandamount. - PIX refund with Split — distributes the refund across subsellers using
additional_data.split.subseller_list_payment. - Cashout cancel — reverses a purchase with cash withdrawal. The root-level
cancellation_with_cashoutis mandatory andamountmust be omitted. The response returns the reversed value inamountand the original withdrawal value incashout_amount. Getnet Argentina (AR) only.
Usage Scenarios:
- Voiding a payment made by mistake.
- Handling order cancellations that require a full refund._
Notes:
- The cancellation process may vary depending on the payment method and issuer.
- Some transactions may require additional processing time before the funds are returned to the customer._
Body application/json
Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.
Request identifier. Unique for each request.
Payment identifier
Indicates whether the cancellation is a safe reversal of a transaction denied by the EC Credenciador (merchant/creditor). When set to true, signals that the reversal is authorized even when the original transaction was denied. Optional field. [R261.8]
Defines how much of a Cashout transaction (purchase with cash withdrawal) the cancellation reverses. Send it at the root of the cancellation request. Mandatory when you cancel a Cashout transaction. Getnet Argentina (AR) only.
Set it to true to reverse the whole operation: purchase and withdrawal. Set it to false to reverse the purchase only and leave the withdrawal with the cardholder.
Do not send amount together with this field. The response returns the reversed value in amount and the original withdrawal value in cashout_amount.
Cashout cancellations follow a 13:00 (AR) cut-off, so send the request before that time.
Additional cancellation data.
Value (less than or equal) of the purchase in cents. Partial cancellation (of lower value) is allowed only from the day following the transaction (D+N)
Do not send this field when you cancel a Cashout transaction. Send cancellation_with_cashout instead, and the API derives the reversed value.
Customer key used to identify a cancellation request. (Key must be unique per transaction).
Response
Transaction executed successfully.
Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.
ECommerce identification code
Request identifier. Unique for each request.
Payment identifier
Purchase identification code used by e-commerce (code or order number).
Value reversed by the cancellation, in cents.
For a Cashout cancellation, the value depends on cancellation_with_cashout. When you sent true, amount matches the amount of the original authorization. When you sent false, amount is the original authorization amount minus the data.cashout.cashout_amount you sent on that authorization.
Cash withdrawal amount of the original transaction, in cents. Returned when the cancellation carries cancellation_with_cashout. Getnet Argentina (AR) only.
Currency identification (See code in this section).
Cancel Status
Return code from the sender or the getnet capture system.
Return message from the sender or the getnet capture system.
Cancellation date
Customer key used to identify a cancellation request. (Key must be unique per transaction).
Invalid Requisition
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Invalid Authentication
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Not Found
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Unprocessable Entity
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Unprocessable Entity
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Internal server or service error
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Internal server or service error
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.
Gateway Timeout
Detailed error message.
Name of the module or system in which the error occurred.
HTTP status code of the error.
Error details.
Error details.
combinedId.
orderId.
sellerId.