Refund or cancel a payment

POST

/payments/{paymentPspReference}/reversals

Refunds a payment if it has already been captured, and cancels a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCEL_OR_REFUND webhook.

The reversed amount is always the full payment amount.

Do not use this request for payments that involve multiple partial captures.

For more information, refer to Reversal.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟢201Created - the request has been fulfilled and has resulted in one or more new resources being created.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/payments//reversals' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantAccount": "string",
    "reference": "string"
}'

Response Example

200 - Example 1

{
    "merchantAccount": "string",
    "paymentPspReference": "string",
    "pspReference": "string",
    "reference": "string",
    "status": "received"
}

Modified at 2023-08-15 09:16:27

Refund a captured payment

Get the list of brands on the card