Reverse payment
Use this method to cancel or to partially cancel a payment in an open batch. This is also known as voiding a payment.
To cancel a payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.
Note: If you don’t have the paymentId, use our List Payments method to search for the payment.
If your request is successful, our gateway removes the payment from the merchant’s open batch and no funds are taken from the cardholder’s account.
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Request
Amount of the payment that the merchant wants to reverse. The value is in the currency’s lowest denomination, for example, cents.
Note: If the merchant doesn’t send an amount, we reverse the total amount of the transaction.
Response
Array of operations that you can perform on the transaction.
capture
- Capture the payment.refund
- Refund the payment.fullyReverse
- Fully reverse the transaction.partiallyReverse
- Partially reverse the payment.incrementAuthorization
- Increase the amount of the authorization.adjustTip
- Adjust the tip post-payment.addSignature
- Add a signature to the payment.setAsReady
- Set the transaction’s status toready
.setAsPending
- Set the transaction’s status topending
.setAsDeclined
- Set the transaction’s status todeclined
.