On This Page

Reverse an Authorization

You can cancel an authorized payment by requesting an authorization reversal, which removes the hold on any authorized funds. An authorization reversal is typically requested when a customer cancels a payment or a merchant captures less than the total authorized amount. You cannot reverse a reauthorized transaction.

Endpoints

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/reversals

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/reversals

Set the {id}
to the request ID returned in the authorization request.

Required Fields for Reversing an Authorization

paymentInformation.paymentType.method.name: Set to one of these values:

payPal
: the PayPal payment method.
venmo
: the Venmo payment method.
paymentInformation.paymentType.name: Set to
eWallet
.
processingInformation.actionList: Set to
AP_AUTH_REVERSAL
.

Example: Reversing an Authorization

Request

{
    "paymentInformation": {
        "paymentType": {
            "method": {
                "name": "payPal"
            },
            "name": "eWallet"
        }
    },
    "processingInformation": {
        "actionList": [
            "AP_AUTH_REVERSAL"
        ]
    }
}

Response to a Successful Request

{
    "message": "Successful",
    "status": "REVERSED",
    "id": "7259791326166018601991",
    "submitTimeUtc": "2024-09-10T14:38:52Z"
}

Response Statuses for Reversing an Authorization

Cybersource responds to your request with one of these statuses in the

status

response field:

REVERSED

: The reversal request was successful, and the authorized funds are released from hold.

INVALID_REQUEST

: The reversal request was not successful. Send a new reversal request.