Change the authorised amount
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 Parameters
This field contains additional data, which may be required for a particular modification request.
The additionalData object consists of entries, each of which includes the key and value.
The merchant account that is used to process the payment.
The amount that needs to be adjusted. The currency
must match the currency used in authorisation, the value
must be smaller than or equal to the authorised amount.
Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
The original merchant reference to cancel.
The original pspReference of the payment to modify. This reference is returned in:
- authorisation response
- authorisation notification
Defines how to book chargebacks when using Adyen for Platforms.
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for platforms.
The transaction reference provided by the PED. For point-of-sale integrations only.
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.