Adyen Payment API
  1. Modifications
Adyen Payment API
  • Modifications
    • Change the authorised amount
      POST
    • Cancel an authorisation
      POST
    • Cancel or refund a payment
      POST
    • Capture an authorisation
      POST
    • Create a donation
      POST
    • Refund a captured payment
      POST
    • Cancel an authorisation using your reference
      POST
    • Cancel an in-person refund
      POST
  • General
    • Create an authorisation
      POST
    • Complete a 3DS authorisation
      POST
    • Complete a 3DS2 authorisation
      POST
    • Get the 3DS authentication result
      POST
    • Get the 3DS2 authentication result
      POST
  1. Modifications

Change the authorised amount

POST
/adjustAuthorisation
Modifications
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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/adjustAuthorisation' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
200 - Example 1
{
    "additionalData": {
        "property1": "string",
        "property2": "string"
    },
    "pspReference": "string",
    "response": "[capture-received]"
}

Request

Body Params application/json
additionalData
object  | 
optional
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.
Any of
Could not resolve '#/components/schemas/AdditionalData3DSecure'
merchantAccount
string 
required
The merchant account that is used to process the payment.
modificationAmount
object (Amount) 
required
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.
currency
string 
required
The three-character ISO currency code.
>= 3 characters<= 3 characters
value
integer <int64>
required
The amount of the transaction, in minor units.
mpiData
object (ThreeDSecureData) 
optional
Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
authenticationResponse
enum<string> 
optional
In 3D Secure 1, the authentication response if the shopper was redirected.
In 3D Secure 2, this is the transStatus from the challenge result. If the transaction was frictionless, omit this parameter.
Allowed values:
YNUA
cavv
string 
optional
The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
cavvAlgorithm
string 
optional
The CAVV algorithm used. Include this only for 3D Secure 1.
challengeCancel
enum<string> 
optional
Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to 3D Secure API reference.
Allowed values:
01020304050607
directoryResponse
enum<string> 
optional
In 3D Secure 1, this is the enrollment response from the 3D directory server.
In 3D Secure 2, this is the transStatus from the ARes.
Allowed values:
ACDINRUY
dsTransID
string 
optional
Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
eci
string 
optional
The electronic commerce indicator.
riskScore
string 
optional
Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
threeDSVersion
string 
optional
The version of the 3D Secure protocol.
tokenAuthenticationVerificationValue
string 
optional
Network token authentication verification value (TAVV). The network token cryptogram.
transStatusReason
string 
optional
Provides information on why the transStatus field has the specified value. For possible values, refer to our docs.
xid
string 
optional
Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
originalMerchantReference
string 
optional
The original merchant reference to cancel.
originalReference
string 
required
The original pspReference of the payment to modify.
This reference is returned in:
authorisation response
authorisation notification
platformChargebackLogic
object (PlatformChargebackLogic) 
optional
Defines the behavior to be applied in case of a chargeback.
behavior
enum<string> 
optional
Allowed values:
deductAccordingToSplitRatiodeductFromLiableAccountdeductFromOneBalanceAccount
costAllocationAccount
string 
optional
targetAccount
string 
optional
reference
string 
optional
Your reference for the payment modification. This reference is visible in Customer Area and in reports.
Maximum length: 80 characters.
splits
array[object (Split) {5}] 
optional
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to Providing split information.
account
string 
optional
Unique identifier of the account where the split amount should be sent. This is required if type is MarketPlace or BalanceAccount.
amount
object (SplitAmount) 
required
The amount of this split.
description
string 
optional
A description of this split.
reference
string 
optional
Your reference for the split, which you can use to link the split to other operations such as captures and refunds.
This is required if type is MarketPlace or BalanceAccount. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated TransferBalance record type in Adyen for Platforms.
type
enum<string> 
required
The type of split.
Possible values: Default, PaymentFee, VAT, Commission, MarketPlace, BalanceAccount, Remainder, Surcharge, Tip.
Allowed values:
BalanceAccountCommissionDefaultMarketPlacePaymentFeeRemainderSurchargeTipVATVerification
tenderReference
string 
optional
The transaction reference provided by the PED. For point-of-sale integrations only.
uniqueTerminalId
string 
optional
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
additionalData
object 
optional
This field contains additional data, which may be returned in a particular modification response.
Additional properties
string 
optional
pspReference
string 
required
Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
response
enum<string> 
required
Indicates if the modification request has been received for processing.
Allowed values:
[capture-received][cancel-received][refund-received][cancelOrRefund-received][adjustAuthorisation-received][donation-received][technical-cancel-received][voidPendingRefund-received]
🟠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.
Modified at 2023-08-15 08:20:06
Next
Cancel an authorisation
Built with