In a basic payment flow, the payable amount from your payment request is authorised and then captured. But sometimes you may want to change the amount or extend the length of the authorisation. You can enable this using the authorisation type pre-authorisation with your payment request. In this payment flow you can increase or decrease the authorised amount at a later stage, and then capture the payment. We refer to these changes to a pre-authorised payment as authorisation adjustments.
Authorisation adjustment is currently available for Discover, Mastercard, Visa, and American Express. Support is ultimately up to the issuer. See Availability for more information.
There are several use cases for adjusting an authorisation:
Hospitality. For example, in a hotel:
- At the checkout page of the hotel's website or app, the hotel pre-authorises payment of the room that the guest booked. At the same time, the hotel stores the shopper's payment information, to be able to apply late charges when necessary.
- During their stay, the guest incurs expenses at the hotel facilities. The hotel adds these expenses to the pre-authorised amount by adjusting the authorisation.
- When the guest checks out, the hotel captures the final amount, or cancels the payment if the guest prefers to settle their bill with a different payment method.
- If necessary, the hotel charges the guest after they have left, using the shopper's stored payment details for a new payment.
- Pre-ordering items. For example, a shopper pre-orders a video game that will be released three months later. The video game seller authorises the payment, but as they can only ship the product three months later, they need to extend the authorisation validity.
For some card schemes, you can set card payment requests to be handled as either a pre-authorisation or a final authorisation.
- Pre-authorisation: This is intended for use cases as described above, when you don't yet know the amount to be captured. It allows you to increase or decrease the initially authorised amount at a later point in time using the /adjustAuthorisation endpoint.
- Final authorisation: Use this when the final amount is agreed up front and the transaction will definitely be captured in full. It's not possible to adjust the authorised amount.
By default, Adyen handles all card payment requests as final authorisations.
To set an authorisation type, you can either:
- Define the default authorisation type at the merchant account level for all card transactions. See Configure your account.
- Manually specify the authorisation type (PreAuth or FinalAuth) in each payment request. See Pre-authorise a payment.
Asynchronous or synchronous adjustment
There are two ways to implement pre-authorisation:
With asynchronous authorisation adjustment, you refer to a payment using the PSP reference that you received in the response to your pre-authorisation request. In each authorisation adjustment request as well as in the final capture request, you only need to specify this first PSP reference.
Asynchronous adjustment is easier to implement, but it is not immediately clear if the adjustment succeeded. You need to set up webhook notifications to receive updates and to know if the final amount was authorised before you capture the payment.
With synchronous authorisation adjustment, you pass an
adjustAuthorisationDatablob from one authorisation adjustment to the next, to enable us to keep track of the latest amount. You receive the first blob in the response to your pre-authorisation request. In your first authorisation adjustment request, you specify the blob you received for the pre-authorisation, and you receive a new blob in the response. In your next adjustment, you specify the blob that you received in the response for the previous adjustment, and so on.
Synchronous adjustment requires an additional step to implement, because you need to keep track of the latest blob to submit it in the subsequent adjust authorisation request. The advantage is that you receive the adjustment result synchronously. In this way you immediately know if the final amount was authorised before you capture the payment.
If at some stage you fail to pass the blob, the flow falls back to asynchronous adjustment and it is no longer possible to return to synchronous adjustment for that payment.
Before you begin
Before you configure and use pre-authorisation:
- Make sure that you have built an integration that can make a payment.
- Set up webhook notifications. You'll need to rely on notifications to know whether the capture succeeded. If you use asynchronous authorisation adjustment, you'll also need to rely on notifications for the authorisation adjustment result.
You also need to implement logic on your end, for example to decide when to use the pre-authorisation flow, and to calculate the amount when you make an authorisation adjustment.
(Optional) Configure your account
There are two aspects of your account that you may want to configure for pre-authorisation and authorisation adjustment:
Synchronous authorisation adjustment: To receive the initial
adjustAuthorisationDatablob with your pre-authorisation request and to subsequently receive the authorisation adjustment results synchronously, ask our Support Team to enable this.
Default authorisation type: If you only do pre-authorisation payment requests, you can ask our Support Team to set your default authorisation type to PreAuth so that you don't have to specify it in your payment requests.
If you want to do both pre-authorisation payment requests and regular payment requests, we recommend you specify the authorisation type in all payment requests. Pre-authorised transactions incur scheme fees.
Step 1: Pre-authorise a payment
Make a payment request, and additionally specify:
- Store the
pspReferencefrom the response for later use when adjusting the authorisation or capturing the payment.
Step 2: (Optional) Modify the authorisation
You can't make a zero-value authorisation when you adjust an authorisation.
Adjust the pre-authorisation amount
To modify the pre-authorised amount, make an authorisation adjustment request.
Extend the authorisation
To extend the authorisation period make an /adjustAuthorisation request with the same amount as the current balance on the authorisation:
- If you haven't adjusted the authorisation yet, use the amount from the original pre-authorisation request.
- If you did adjust the authorisation, use the amount from the last adjustment.
For Mastercard, the request made to adjust the pre-authorised amount automatically extends the validity period of the authorisation. So, if you have adjusted an authorisation, you don't immediately have to extend its validity.
We strongly recommend you to use the asynchronous flow to extend the authorisation. Visa only supports the asynchronous flow.
See Adjust the authorisation for instructions. To check the status of the authorisation (the original and the extension), make sure to consume notification webhooks.
For Visa and American Express, the issuer can refuse the request to extend the authorisation period. This refusal terminates the initially authorised payment. Check that you consume the notification to handle this situation by either withholding shipment or authorising the card again at a later time.
Step 3: Finalize the pre-authorised payment
When you have made your last authorisation adjustment, you need to manually capture the payment to transfer the reserved funds to your account:
Decide whether you are ready to capture the payment:
Are there any additional charges to be made?
If yes, adjust the authorisation first (see Adjust the authorisation).
Does the shopper want to settle the bill using a different payment method than the one used for the pre-authorisation?
If yes, do not capture the payment. Instead, cancel the pre-authorisation:
When you are ready to capture the payment, make a POST request to the /capture endpoint, specifying:
Parameter Required Description
pspReferenceof the original pre-authorisation. You received this in the response to your pre-authorisation request.
valueof the final amount in minor units. This is the sum of the original, pre-authorised amount and all later adjustments.
Your reference to this payment modification, for use in your reconciliation process.
The name of your merchant account that is used to process the payment.
When you receive the /capture response, note the following:
pspReference: The PSP reference associated with this /capture request. Note that this is different from the PSP reference associated with the pre-authorisation request.
additionalData.merchantReference: Your reference to this payment modification, for use in your reconciliation process.
Wait for the asynchronous notification. This informs you whether the final amount has been captured.
If the capture is successful, this notification contains:
pspReferenceof the pre-authorisation.
pspReference: The PSP reference associated with this /capture` request.
successis false then your capture request failed. Review the
reasonyou received in the notification, fix the issue, and submit the capture request again.
You can combine the steps listed before to fulfill your use case. For example, if you want to do multiple partial captures, modify the amount authorised after the first partial capture. To do so, pre-authorise a payment, partially capture the payment, and then adjust the authorisation amount.
You can use adjust authorisation for certain business models that are most common in travel, public transport, and restaurant businesses. Card schemes set specific rules around which businesses are able to adjust an authorisation. Your eligibility is determined by your Merchant Category Code (MCC), together with the card scheme.
To obtain the required MCC value:
- Log in to your live Customer Area.
- Select your merchant account.
- Go to Settings > Payment methods.
- Scroll to the right of the table to see your MCC for the relevant payment methods.
Use the following table to see if your business is eligible to adjust authorisations:
|Scheme||Available Merchant Category Codes (MCC)|
|Visa||Within Europe: all MCCs
Outside of Europe: 3351-3500, 3501-3999, 4111, 4112, 4121, 4131, 4411, 5311, 5411, 5072, 5137, 5552, 5651, 5691, 5732, 5734, 5812, 5814, 5945, 7011, 7033, 7211, 7338, 7394, 7512, 7513, 7519, 7523, 7542, 7841, 7996, 7999.
Adjust authorisation does not work for V Pay cards.
|Discover||3351-3441, 3501-3999, 4111, 4112, 4121, 4131, 4411, 4457, 5812, 5813, 7011, 7033, 7996, 7394, 7512, 7513, 7519, 7999.|
|American Express||All MCCs|
Adyen expires an authorisation request automatically after:
- 28 days from the day the payment is authorised, for all major global card networks, except Cartes Bancaires.
- 12 days from the day the payment is authorised, for Cartes Bancaires.
The default expiry period can be adjusted and ensures that Adyen does not automatically expire the authorization after the default 28 days. Contact our Support Team to configure a custom expiry date for you and specify the merchant accounts, schemes and timeframe in hours or days.
Note that card schemes, too, have their own set of rules on authorisation expiry. Capturing a transaction after the scheme expiry time increases the risk of a failed capture, and may also increase the interchange and/or scheme fees charged for the transaction. Card schemes can also expire an authorisation before or after the official scheme expiry period has been reached.
You can often capture a payment successfully after an authorisation has expired. Depending on the card scheme, there can be a fee for late capture, and an increase in interchange fee. The risk of cardholder chargebacks increase as well.
The following tables include expiry information from major card schemes:
|Carte Bancaires||All||All||All||All||13 days|
|Carte Bancaires||All||All||All||Car Rental||20 days|
|Carte Bancaires||All||All||All||Airline in-flight||34 days|
|Carte Bancaires||All||All||Pre-auth||Travel sector||30 days|
|Diners||All||All||All||Car Rental, Hotel/Lodging||30 days|
|Discover||All||All||All||Car Rental, Hotel/Lodging MCCs||30 days|
|JCB||All||All||Pre-auth||Hotel and Car rental||Time of stay/rental|
|Mastercard||All||All||Final auth||All||7 days|
|Visa electron||All||All||All||All||5 days|
|Visa||All||All||Pre-Auth||Cruise, Lodging, Vehicle Rental||31 days|
|Visa||All||Subscriptions and UnscheduledCardOnFile||All||All||1 day|