On This Page
Reverse an Authorized Payment
The authorization-reversal request enables you to reverse a transaction's authorized
amount. You may need to reverse an authorized payment when either you or the customer
decide to cancel a payment. Requesting an authorization-reversal requires the
id
from the
authorization response.Calculating the Grand Total
Include the grand total in the request by using the
orderInformation.amountDetails.totalAmount
field. Endpoints
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/reversalsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/reversalsSet the to the request ID
returned in the authorization request.
{id}
Response Statuses
The authorization-reversal service responds with
one of these statuses as the
status
field value:- AUTH_REVERSED: The authorization is successfully reversed.
- FAILED: The authorization-reversal failed.
processorInformation.responseCode
field value.
Required Fields for Reversing an Authorized
Payment
Include these required fields to reverse an authorization.
Example: Reversing an Authorized Payment
Request
{ "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "name": "BNPL", "method": { "name": "ONEY" } } }, "processingInformation": { "actionList": "AP_AUTH_REVERSAL" } }
Response
{ "_links": { "self": { "method": "POST", "href": "/pts/v2/reversals/7546772446526724804805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546772446526724804805" } }, "clientReferenceInformation": { "code": "refnum-1234" }, "id": "7546772446526724804805", "processorInformation": { "responseDetails": "00007", "responseCode": "00007" }, "reconciliationId": "XFZ40E1G1CKL", "reversalAmountDetails": { "reversedAmount": "0" }, "status": "AUTH_REVERSED", "submitTimeUtc": "2025-08-08T18:20:49Z" }