younifyd
Menu

Update an authorised amount

Update an authorised amount

POST/payments/{paymentPspReference}/amountUpdates

Use it in a workflow

  1. Add a step and choose the Adyen connector.
  2. Pick the Update an authorised amount action (under Modifications).
  3. Fill in the fields below, then reference the result from later steps as {{updateAnAuthorisedAmount.response.data}}.

Request

Path parameters

paymentPspReferencestringrequired

The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment.

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

Enter the body as JSON in the step's Body field.

adjustAuthTypestring

The type of adjustment. Possible values: * **cardholderInitiatedTransaction** * **merchantInitiatedTransaction**

One ofcardholderInitiatedTransactionmerchantInitiatedTransaction

adjustAuthorisationDatastring

The required data to make a [synchronous authorization adjustment](https://docs.adyen.com/online-payments/adjust-authorisation). Pass the corresponding value from the `/payments` response or webhook message.

amountobjectrequired
currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

applicationInfoobject
adyenLibraryobject2 fields
adyenPaymentSourceobject2 fields
externalPlatformobject3 fields
merchantApplicationobject2 fields
merchantDeviceobject3 fields
shopperInteractionDeviceobject3 fields
industryUsagestring

The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**

One ofdelayedChargeinstallmentnoShow

lineItemsarray<object>

Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.

amountExcludingTaxinteger (int64)

Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

amountIncludingTaxinteger (int64)

Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

brandstring

Brand of the item.

colorstring

Color of the item.

descriptionstring

Description of the line item.

idstring

ID of the line item.

imageUrlstring

Link to the picture of the purchased item.

itemCategorystring

Item category, used by the payment methods PayPal and Ratepay.

manufacturerstring

Manufacturer of the item.

marketplaceSellerIdstring

Marketplace seller id.

productUrlstring

Link to the purchased item.

quantityinteger (int64)

Number of items.

receiverEmailstring

Email associated with the given product in the basket (usually in electronic gift cards).

returnShippingCompanystring

Shipping company handling the return of the item.

returnTrackingNumberstring

Tracking number for the return of the item.

returnTrackingUristring

Tracking URI for the return of the item.

riskCategorystring

An optional, free-text category for the item to be used in the risk evaluation. When provided, Protect uses this value to evaluate custom risk rules.

shippingCompanystring

Shipping company handling the delivery of the item.

shippingMethodstring

Shipping method used to deliver the item.

sizestring

Size of the item.

skustring

Stock keeping unit.

taxAmountinteger (int64)

Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

taxPercentageinteger (int64)

Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent)

trackingNumberstring

Tracking number for the delivery of the item.

trackingUristring

Tracking URI for the delivery of the item.

upcstring

Universal Product Code.

merchantAccountstringrequired

The merchant account that is used to process the payment.

mpiDataobject
authenticationResponsestring

In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.

One ofYNUA

cavvstring (byte)

The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).

cavvAlgorithmstring

The CAVV algorithm used. Include this only for 3D Secure 1.

challengeCancelstring

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](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).

One of01020304050607

directoryResponsestring

In 3D Secure 2, this is the `transStatus` from the `ARes`.

One ofACDINRUY

dsTransIDstring

Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

ecistring

The electronic commerce indicator.

riskScorestring

Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.

threeDSVersionstring

The version of the 3D Secure protocol.

tokenAuthenticationVerificationValuestring (byte)

Network token authentication verification value (TAVV). The network token cryptogram.

transStatusReasonstring

Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).

xidstring (byte)

Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).

referencestring

Your reference for the amount update request. Maximum length: 80 characters.

splitsarray<object>

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments) or [platforms](https://docs.adyen.com/platforms/process-payments).

accountstring

The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.

amountobject2 fields
descriptionstring

Your description for the split item.

referencestring

Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.

typestringrequired

The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of the payment (specified in `amount`) to the specified `account`. * Transaction fees types that you can book to the specified `account`: * **AcquiringFees**: The aggregated amount of the interchange and scheme fees. * **PaymentFee**: The aggregated amount of all transaction fees. * **AdyenFees**: The aggregated amount of Adyen's commission and markup fees. * **AdyenCommission**: The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **Interchange**: The fees paid to the issuer for each payment made with the card network. * **SchemeFee**: The fees paid to the card scheme for using their network. * **Commission**: Your platform's commission on the payment (specified in `amount`), booked to your liable balance account. * **Remainder**: The amount left over after a currency conversion, booked to the specified `account`. * **Surcharge**: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * **TopUp**: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * **VAT**: The value-added tax charged on the payment, booked to your platforms liable balance account. * **Default**: In very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**.

One ofAcquiringFeesAdyenCommissionAdyenFeesAdyenMarkupBalanceAccountCommissionDefaultInterchangeMarketPlacePaymentFeeRemainderSchemeFeeSurchargeTipTopUpVAT

json
{
  "amount": {
    "currency": "string",
    "value": 0
  },
  "merchantAccount": "string",
  "adjustAuthType": "cardholderInitiatedTransaction",
  "adjustAuthorisationData": "string",
  "applicationInfo": {
    "adyenLibrary": {
      "name": "string",
      "version": "string"
    },
    "adyenPaymentSource": {
      "name": "string",
      "version": "string"
    },
    "externalPlatform": {
      "integrator": "string",
      "name": "string",
      "version": "string"
    },
    "merchantApplication": {
      "name": "string",
      "version": "string"
    },
    "merchantDevice": {
      "os": "string",
      "osVersion": "string",
      "reference": "string"
    },
    "shopperInteractionDevice": {
      "locale": "string",
      "os": "string",
      "osVersion": "string"
    }
  },
  "industryUsage": "delayedCharge",
  "lineItems": [
    {
      "amountExcludingTax": 0,
      "amountIncludingTax": 0,
      "brand": "string",
      "color": "string",
      "description": "string",
      "id": "string",
      "imageUrl": "string",
      "itemCategory": "string",
      "manufacturer": "string",
      "marketplaceSellerId": "string",
      "productUrl": "string",
      "quantity": 0
    }
  ],
  "mpiData": {
    "authenticationResponse": "Y",
    "cavv": "string",
    "cavvAlgorithm": "string",
    "challengeCancel": "01",
    "directoryResponse": "A",
    "dsTransID": "string",
    "eci": "string",
    "riskScore": "string",
    "threeDSVersion": "string",
    "tokenAuthenticationVerificationValue": "string",
    "transStatusReason": "string",
    "xid": "string"
  },
  "reference": "string",
  "splits": [
    {
      "type": "AcquiringFees",
      "account": "string",
      "amount": {
        "value": 0,
        "currency": "string"
      },
      "description": "string",
      "reference": "string"
    }
  ]
}

Response

Returns 201 with an object. Read it in later steps with {{updateAnAuthorisedAmount.response.data.<field>}}.

adjustAuthorisationDatastring

The data blob for subsequent synchronous adjust authorisation calls. Returned when the synchronous flow is used.

amountobject
currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.

valueinteger (int64)required

The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).

industryUsagestring

The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**

One ofdelayedChargeinstallmentnoShow

lineItemsarray<object>

Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.

amountExcludingTaxinteger (int64)

Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

amountIncludingTaxinteger (int64)

Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

brandstring

Brand of the item.

colorstring

Color of the item.

descriptionstring

Description of the line item.

idstring

ID of the line item.

imageUrlstring

Link to the picture of the purchased item.

itemCategorystring

Item category, used by the payment methods PayPal and Ratepay.

manufacturerstring

Manufacturer of the item.

marketplaceSellerIdstring

Marketplace seller id.

productUrlstring

Link to the purchased item.

quantityinteger (int64)

Number of items.

receiverEmailstring

Email associated with the given product in the basket (usually in electronic gift cards).

returnShippingCompanystring

Shipping company handling the return of the item.

returnTrackingNumberstring

Tracking number for the return of the item.

returnTrackingUristring

Tracking URI for the return of the item.

riskCategorystring

An optional, free-text category for the item to be used in the risk evaluation. When provided, Protect uses this value to evaluate custom risk rules.

shippingCompanystring

Shipping company handling the delivery of the item.

shippingMethodstring

Shipping method used to deliver the item.

sizestring

Size of the item.

skustring

Stock keeping unit.

taxAmountinteger (int64)

Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).

taxPercentageinteger (int64)

Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent)

trackingNumberstring

Tracking number for the delivery of the item.

trackingUristring

Tracking URI for the delivery of the item.

upcstring

Universal Product Code.

merchantAccountstring

The merchant account that is used to process the payment.

paymentPspReferencestring

The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to update.

pspReferencestring

Adyen's 16-character reference associated with the amount update request.

referencestring

Your reference for the amount update request. Maximum length: 80 characters.

splitsarray<object>

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments) or [platforms](https://docs.adyen.com/platforms/process-payments).

accountstring

The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.

amountobject2 fields
descriptionstring

Your description for the split item.

referencestring

Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.

typestringrequired

The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of the payment (specified in `amount`) to the specified `account`. * Transaction fees types that you can book to the specified `account`: * **AcquiringFees**: The aggregated amount of the interchange and scheme fees. * **PaymentFee**: The aggregated amount of all transaction fees. * **AdyenFees**: The aggregated amount of Adyen's commission and markup fees. * **AdyenCommission**: The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **Interchange**: The fees paid to the issuer for each payment made with the card network. * **SchemeFee**: The fees paid to the card scheme for using their network. * **Commission**: Your platform's commission on the payment (specified in `amount`), booked to your liable balance account. * **Remainder**: The amount left over after a currency conversion, booked to the specified `account`. * **Surcharge**: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * **TopUp**: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * **VAT**: The value-added tax charged on the payment, booked to your platforms liable balance account. * **Default**: In very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**.

One ofAcquiringFeesAdyenCommissionAdyenFeesAdyenMarkupBalanceAccountCommissionDefaultInterchangeMarketPlacePaymentFeeRemainderSchemeFeeSurchargeTipTopUpVAT

statusstring

The status of your request. If you included `adjustAuthorisationData` in your request, possible values are the following: * **authorised** * **refused** Otherwise, the value is **received**.

One ofauthorisedreceivedrefused

json
{
  "amount": {
    "currency": "string",
    "value": 0
  },
  "merchantAccount": "string",
  "paymentPspReference": "string",
  "pspReference": "string",
  "reference": "string",
  "status": "authorised",
  "adjustAuthorisationData": "string",
  "industryUsage": "delayedCharge",
  "lineItems": [
    {
      "amountExcludingTax": 0,
      "amountIncludingTax": 0,
      "brand": "string",
      "color": "string",
      "description": "string",
      "id": "string",
      "imageUrl": "string",
      "itemCategory": "string",
      "manufacturer": "string",
      "marketplaceSellerId": "string",
      "productUrl": "string",
      "quantity": 0
    }
  ],
  "splits": [
    {
      "type": "AcquiringFees",
      "account": "string",
      "amount": {
        "value": 0,
        "currency": "string"
      },
      "description": "string",
      "reference": "string"
    }
  ]
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.