Change the authorised amount

POST

/adjustAuthorisation

Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.

This endpoint is part of our classic API integration.
If you have a newer integration, and are doing:
Asynchronous adjustments, use the /payments/{paymentPspReference}/amountUpdates endpoint on Checkout API.
Synchronous adjustments, use this endpoint.

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 '/adjustAuthorisation' \
--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