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.
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
The updated amount. The
currency must match the currency used in authorisation.
The reason for the amount update. Possible values:
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.
The merchant account that is used to process the payment.
Your reference for the amount update request. Maximum length: 80 characters.
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.
The request has been fulfilled and has resulted in one or more new resources being created.Show more
A problem reading or understanding the request.Show more
Authentication required.Show more
Insufficient permissions to process the request.Show more
A request validation error.Show more
The server could not process the request.Show more