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.

Endpoint destination URL

Click to copy

Header parameters

Idempotency-Key string

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

Path parameters

paymentPspReference string Required

The pspReference of the payment.

Request parameters

amount object Required

The updated amount. The currency must match the currency used in authorisation.

industryUsage string

The reason for the amount update. Possible values:

  • delayedCharge
  • noShow
  • installment
lineItems array [object]

Price and product information of the refunded items, required for partial refunds.

This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.

merchantAccount string Required

The merchant account that is used to process the payment.

reference string

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

splits array [object]

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.

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.

HTTP Responses

  • 201 - Created

    The request has been fulfilled and has resulted in one or more new resources being created.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy