Authorization Reversals

This section provides the information you need in order to process an authorization reversal.
Reversing an authorization releases the hold on the customer’s payment card funds that the issuing bank placed when processing the authorization.

Supported Card Types

All supported card types can process reversals. For a list of all supported card types, see Payment Processors.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments/
{id}
/reversals
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments/
{id}
/reversals
The
{id}
 is the transaction ID returned in the authorization response.

Required Fields for Processing an Authorization Reversal

Cybersource
provides the value for this field.
id
Set the
id
URL parameter to the transaction ID that was included in the authorization response message.
For
Visa Platform Connect
, when reversing the authorization of an Apple Pay transaction on the mada Pay mobile app, set this field to
060
. Apple Pay transactions on the mada Pay app are supported for these cards issued in the Kingdom of Saudi Arabia:
  • mada debit and prepaid cards
  • Mastercard payment cards co-badged with mada
  • Visa payment cards co-badged with mada
The amount of the reversal must be the same as the authorization amount that was included in the authorization response message. Do not use the amount that was requested in the authorization request message.

REST Example: Processing an Authorization Reversal

Request 
        
{ 
    "clientReferenceInformation": { 
      "code": "test123"
    } 
    "orderInformation" : { 
        "amountDetails" : { 
            "currency" : "USD" 
        } 
    }, 
    "reversalInformation" : { 
        "amountDetails" : { 
            "totalAmount" : "100.00" 
        } 
    } 
}
Response to a Successful Request 
        
{
    "_links" : {
      "self" : {
          "method" : "GET",
          "href" : "/pts/v2/reversals/6869460219566537303955"
      }
    },
    "clientReferenceInformation" : {
        "code" : "RTS-Auth-Reversal"
    },
    "id" : "6869460219566537303955",
    "orderInformation" : {
        "amountDetails" : {
            "currency" : "USD"
        }
    },
    "processorInformation" : {
        "responseCode" : "200"
    },
    "reconciliationId" : "82kBK3qDNtls",
    "reversalAmountDetails" : {
        "reversedAmount" : "100.00",
        "currency" : "USD"
    },
    "status" : "REVERSED",
    "submitTimeUtc" : "2023-06-16T20:07:02Z"
}