On This Page

Reverse an Authorized Payment

The authorization reversal service enables you to reverse the amount that was authorized. To reverse an authorization, you must have the authorization request ID, which is the

field value from the authorization response. To reverse a follow-on authorization, use the request ID from the follow-on authorization response.

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.

Response Status

The authorization reversal service responds with one of these statuses as the

status

field value:

PENDING

: The authorization reversal request is successful and is currently processing. Send periodic check status requests until you receive an updated status. For more information, see Check a Request Status.

FAILED

: The authorization reversal is not successful. Send a new request. A failed request can be due to either Klarna rejecting the transaction or a technical error.

When you send a check status request for a pending authorization reversal, you can receive this status when the authorization reversal updates:

AUTH_REVERSED

: The authorization is successfully reversed.

Required Fields for Authorization Reversal

Include these required fields to reverse an authorization.

paymentInformation.paymentType.method.name: Set to
KLARNA
.
paymentInformation.paymentType.name: Set to
INVOICE
.
processingInformation.actionList: Set to
AP_AUTH_REVERSAL

Optional Field for Authorization Reversal

Example: Reversing an Authorization

Request

{
  "paymentInformation": {
    "paymentType": {
      "name": "INVOICE",
      "method": {
        "name": "KLARNA"
      }
    }
  },
  "processingInformation": {
    "actionList": "AP_AUTH_REVERSAL"
  }
}

Response to a Successful Request

{
    "_links": {
        "self": {
            "method": "POST",
            "href": "/pts/v2/reversals/7297199754036380503955"
        },
        "status": {
            "method": "POST",
            "href": "/pts/v2/refresh-payment-status/7297199754036380503955"
        }
    },
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "id": "7291980786556590303955",
    "processorInformation": {
        "responseDetails": "00007",
        "responseCode": "00007"
    },
    "reconciliationId": "XFZ3Z2EJC1OZ",
    "reversalAmountDetails": {
        "reversedAmount": "0"
    },
    "status": "AUTH_REVERSED",
    "submitTimeUtc": "2024-10-21T17:37:52Z"
}