Update an authorised amount

POST

/payments/{paymentPspReference}/amountUpdates

Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an AUTHORISATION_ADJUSTMENT webhook.

You can only update authorised amounts that have not yet been captured.

The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.

For more information, refer to Authorisation adjustment.

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//amountUpdates' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": {
        "currency": "str",
        "value": 0
    },
    "merchantAccount": "string",
    "reason": "delayedCharge",
    "reference": "string",
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ]
}'

Response Example

200 - Example 1

{
    "amount": {
        "currency": "str",
        "value": 0
    },
    "merchantAccount": "string",
    "paymentPspReference": "string",
    "pspReference": "string",
    "reason": "delayedCharge",
    "reference": "string",
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ],
    "status": "received"
}

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

Cancel an authorised payment