worldline

Documentation

Reversal

Authorization/Pre-Authorization reversal can be used to reverse/void the entire authorized amount (including any adjustments) or part of it that won't be captured due to

  • difficulty in delivering the goods or services

  • customer cancellation

  • detection of suspicious or fraudulent behavior in the transaction.

Reverse an authorization

To reverse an authorization, submit an authorization reversal request using the paymentId obtained in the create payment response. Include reversalAmount object if you would like to reverse part of an authorization amount.

Example partial reversal request & response

Below request (POST /processing/v1/100812/520002526/payments/ pay:ch:etu:xBNVCvvTT3GYTn9oz_asvQ /authorization-reversals) would reverse 15 EUR from the underlying authorized amount of 60 EUR from the given payment id.

{
    "operationId": "e38a3e2d-3658-4d47-bb25-2b5b017aec7c",
    "transactionTimestamp": "2024-10-11T12:23:51.846Z",
    "reversalAmount": {
        "amount": 1500,
        "currencyCode": "EUR",
        "numberOfDecimals": 2
    }
}

You would notice from the response that the underlying authorization amount is reduced from 60 EUR to 45 EUR.

{
    "operationId": "e38a3e2d-3658-4d47-bb25-2b5b017aec7c",
    "responseCode": "0",
    "responseCodeDescription": "Accepted or completed successfully",
    "responseCodeCategory": "APPROVED",
    "responder": "WORLDLINE",
    "payment": {
        "paymentId": "pay:ch:etu:xBNVCvvTT3GYTn9oz_asvQ",
        "status": "AUTHORIZED"
    },
    "totalAuthorizedAmount": {
        "amount": 4500,
        "currencyCode": "EUR",
        "numberOfDecimals": 2
    }
}

Please refer to response handling for more details on the response properties.

Reverse a refund authorization

To reverse a refund authorization, submit a refund authorization reversal request using the refundId obtained in the refund payment (for referenced refund) or create refund (for standalone refund). Include reversalAmount object if you would like to reverse a part of an authorization amount else skip it.

Example refund authorization reversal (full amount) request & response

Below request (POST /processing/v1/100812/520002526/refunds/ pay:ch:etu:DIdEUiWCSSWX8KJMyN7dKQ /authorization-reversals) would reverse the refund authorization (entire amount) of the given refund id.

{
    "operationId": "12ec31f4-32cd-4eb6-b5dc-0b6bc564b333",
    "transactionTimestamp": "2024-10-11T12:53:26.578Z"
}
{
    "operationId": "12ec31f4-32cd-4eb6-b5dc-0b6bc564b333",
    "responseCode": "0",
    "responseCodeDescription": "Accepted or completed successfully",
    "responseCodeCategory": "APPROVED",
    "responder": "WORLDLINE",
    "refund": {
        "refundId": "pay:ch:etu:DIdEUiWCSSWX8KJMyN7dKQ",
        "status": "AUTHORIZED"
    }
}

Please refer to response handling for more details on the response properties.