- Management API\u2014Terminal settings read<\/li>
- Management API\u2014Terminal settings read and write<\/li><\/ul> If you have a Terminal API integration with cloud-based communications<\/a>, you can use the existing API key that you use for Terminal API requests.<\/td>\n<\/tr>\n
\n Webhooks<\/a><\/strong><\/td>\n It is recommended to subscribe to Standard<\/strong> webhooks and enable<\/a> receiving the surcharge amount in AUTHORISATION webhook messages.<\/td>\n<\/tr>\n \n Limitations<\/strong><\/td>\n Requests to live Management API endpoints related to terminal settings are subject to rate limits<\/a>.<\/td>\n<\/tr>\n \n Setup steps<\/strong><\/td>\n Before you start: - Enable receiving the issuer country\/region<\/a> in API responses and webhook messages.<\/li>
- Ask our Support Team<\/a> to enable single tap.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
How it works<\/h2>\n
To use dynamic surcharge:<\/p>\n
- \n
- \n
Design the customer experience. We recommend the following:<\/p>\n
- \n
- \n
To inform customers about the changed amount after the surcharge is calculated, configure showing<\/a> the surcharge confirmation screen<\/a>. If you hide this screen, regulations require you to provide another form of surcharge disclosure.<\/p>\n<\/li>\n
- \n
Use the single tap flow. This means that for contactless payments, customers do not need to tap again when they confirm they accept the surcharge. Contact our Support Team<\/a> to enable single tap.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n
- \n
To get the details that are needed to calculate the surcharge amount, you make a card acquisition request<\/a>. These details include, for example, the transaction amount and currency, card brand, funding source, and issuing country of the card.<\/p>\n
Note the following:<\/p>\n
- \n
- In Australia the surcharge compliance requirements are simple enough that you can consider skipping card acquisition.<\/li>\n
- \n
Also note that Mobile solutions currently do not support card acquisition.<\/p>\n\n<\/li>\n<\/ul>\n<\/li>\n
- \n
On the payment terminal, a payment screen appears and the customer taps, inserts, or swipes their card.<\/p>\n<\/li>\n
- \n
When you receive the card acquisition response, you pass the details for the surcharge calculation to your own surcharge calculation logic or to the third-party surcharge calculation service.<\/p>\n<\/li>\n
- \n
When you get the calculated surcharge amount from your own system or the third party, you make a payment request with the surcharge amount<\/a> as the
surchargeFee<\/code> in theSaleToAcquirerData<\/code>. The payment request must also refer to the card acquisition.<\/p>\n<\/li>\n- \n
The surcharge confirmation screen appears. This enables the customer to accept the surcharge, or cancel the transaction.<\/p>\n
\nIn a Mobile solution or if you configured to skip this Adyen-provided confirmation screen, you must provide another form of disclosure.<\/p>\n<\/div>\n<\/li>\n
- \n
If the customer accepts the surcharge, the payment is processed and the payment response shows the surcharge amount in the
TotalFeesAmount<\/code> field.<\/p>\n<\/li>\n<\/ol>\nShow the confirmation screen<\/h2>\n
Adyen provides a surcharge confirmation screen that appears on the payment terminal to let the customer review and accept the surcharge, or cancel the transaction. You can configure this screen to be skipped. But if you do, you must provide another form of disclosure.<\/p>\n
To configure showing or hiding the surcharge confirmation screen:<\/p>\n
- \n
- \n
Optionally, check the current setting for the surcharge confirmation screen by making a GET request to the
\/terminalSettings<\/code> endpoint for the company account<\/a>, merchant account<\/a>, store<\/a> or terminal<\/a>. Check thesurcharge.askConfirmation<\/code> parameter.<\/p>\n<\/li>\n- \n
Make a PATCH request to the
\/terminalSettings<\/code> endpoint for the company account<\/a>, merchant account<\/a>, store<\/a> or terminal<\/a>.
\nIn the request body, specify a surcharge<\/a> object with the following parameter:<\/p>\n - \n
- \n
- \n
- \n
- Ask our Support Team<\/a> to enable single tap.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
- Enable receiving the issuer country\/region<\/a> in API responses and webhook messages.<\/li>
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n