Cancel an in-person refund

POST

/voidPendingRefund

This endpoint allows you to cancel an unreferenced refund request before it has been completed.

In your call, you can refer to the original refund request either by using the tenderReference, or the pspReference. We recommend implementing based on the tenderReference, as this is generated for both offline and online transactions.

For more information, refer to Cancel an unreferenced refund.

Request

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟠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 '/voidPendingRefund' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
    "additionalData": {
        "property1": "string",
        "property2": "string"
    },
    "pspReference": "string",
    "response": "[capture-received]"
}

Modified at 2023-08-15 08:20:06

Cancel an authorisation using your reference

Create an authorisation