{"title":"Configuration-based surcharge","category":"default","creationDate":1776961628,"content":"<p>Using Management API settings, you can configure surcharge rules for your Adyen company or merchant account, store, or individual terminals. Your rules need to take into account all applicable compliance requirements and aspects such as payment method (card brand), funding source, issuing country, and currency.<\/p>\n<p>Based on the rules you configured, surcharges are then automatically calculated and applied to your in-person payments.  In your payment requests, you can use split instructions to define how to book the surcharge amount. <\/p>\n<p>Depending on your <a href=\"\/pt\/platforms\/in-person-payments\/surcharge#surcharge-methods\">use case<\/a>, you can combine configuration-based surcharge with <a href=\"\/pt\/platforms\/in-person-payments\/surcharge\/dynamic\">dynamic surcharge<\/a>.<\/p>\n<h2>Requirements<\/h2>\n<p>In addition to the <a href=\"\/pt\/platforms\/in-person-payments#requirements\">general requirements<\/a> for in-person payments with an Adyen for Platforms integration and the general <a href=\"\/pt\/platforms\/in-person-payments\/surcharge#requirements\">surcharge requirements<\/a>, take into account the following information.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">Configuration-based surcharge is supported with: <ul><li markdown=\"1\">A <a href=\"\/pt\/point-of-sale\/design-your-integration\/\">Terminal API integration<\/a> with payment terminals or with a <a href=\"\/pt\/point-of-sale\/ipp-mobile\/\">Tap to Pay<\/a> Mobile solution.<\/li> <li markdown=\"1\">A <a href=\"\/pt\/point-of-sale\/standalone\">standalone solution<\/a>.<\/li><\/ul> When using payment terminals, note the required terminal software version: <ul><li markdown=\"1\"><strong>v1.108<\/strong> to apply a maximum surcharge amount per transaction.<\/li> <li markdown=\"1\"><strong>v1.112<\/strong> to differentiate between commercial and consumer cards.<\/li> <li markdown=\"1\"><strong>v1.115<\/strong> to exclude gratuities (tips) from surcharging.<\/li> <li markdown=\"1\"><strong>v1.117<\/strong> to apply surcharges to Mail Order\/Telephone Order (MOTO) and Manual Key Entry (MKE) payments.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/api-credentials\">API credentials<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">You must have an API credential with an API key and the following <a href=\"\/pt\/development-resources\/api-credentials#api-permissions\">roles<\/a>: <ul><li markdown=\"1\">Management API\u2014Terminal settings read<\/li> <li markdown=\"1\">Management API\u2014Terminal settings read and write<\/li><\/ul> If you have a Terminal API integration with <a href=\"\/pt\/point-of-sale\/design-your-integration\/choose-your-architecture#cloud-communications\">cloud-based communications<\/a>, you can use the existing API key that you use for Terminal API requests.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">It is recommended to subscribe to <strong>Standard<\/strong> webhooks and <a href=\"\/pt\/platforms\/in-person-payments\/surcharge#surcharge-in-authorisation-webhooks\">enable<\/a> receiving the surcharge amount in AUTHORISATION webhook messages.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Hardware<\/strong><\/td>\n<td style=\"text-align: left;\">Configuration-based surcharge is not supported with <strong>SFO1<\/strong> terminals or with <a href=\"\/pt\/point-of-sale\/ipp-mobile\/\">NYC1 card readers<\/a> (in a Mobile solution).<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">Note the following: <ul><li markdown=\"1\">For surcharges on Tap to Pay transactions, the <a href=\"\/pt\/platforms\/in-person-payments\/surcharge#surcharge-confirmation-screen\">surcharge confirmation screen<\/a> does not show.<\/li> <li markdown=\"1\">Requests to live Management API endpoints related to terminal settings are subject to <a href=\"\/pt\/point-of-sale\/automating-terminal-management#rate-limits-in-the-live-environment\">rate limits<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">For surcharges on Tap to Pay transactions, ask our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to enable single tap.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"how-it-works\">How it works<\/h2>\n<p>After the surcharge amounts and\/or percentages are <a href=\"#configure-surcharges\">configured<\/a>:<\/p>\n<ol>\n<li>\n<p>You make a payment request like you normally do. There are no special parameters required to trigger the surcharge.<\/p>\n<\/li>\n<li>\n<p>The payment terminal or mobile device shows a screen with the purchase amount and instructs  your user's customer  to present their card.<\/p>\n<\/li>\n<li>\n<p>Based on the card that the customer presents, the terminal or Mobile SDK calculates the surcharge using the surcharge amounts and\/or percentages you configured.<\/p>\n<\/li>\n<li>\n<p>Depending on your configuration and solution, the <a href=\"\/pt\/platforms\/in-person-payments\/surcharge#surcharge-confirmation-screen\">surcharge confirmation screen<\/a> appears. This enables  your user's customer  to accept the surcharge, or cancel the transaction.<\/p>\n<div class=\"notices green\">\n<p>In a Mobile solution or if you choose to skip the confirmation screen, you must provide another form of disclosure.<\/p>\n<\/div>\n<\/li>\n<li>\n<p>If  your user's customer  accepts the surcharge, the payment is processed and the payment response shows the surcharge amount in the <code>TotalFeesAmount<\/code> field.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"configure-surcharges\">Configure surcharges<\/h2>\n<p>The payment acceptance fee charged to your user depends on the payment method brand (scheme), funding source (credit or debit), currency, and the country\/region that issued the payment method (domestic or international). Therefore, the surcharge that your user passes on to the customer must be specific for the combination of brand, funding source, currency, and country\/region.<\/p>\n<p>The surcharge can be a fixed amount for each transaction, a percentage of the sum of the purchase amount and the tip, or both a fixed amount and a percentage. You can configure the surcharge logic for payments based on the agreements you have with your users.<\/p>\n<p>In addition, you can:<\/p>\n<ul>\n<li>Specify a maximum surcharge amount.<\/li>\n<li>Indicate if the surcharge should only be applied if the payment method is a commercial\/business card. This is important in countries\/regions where surcharges on consumer cards are not allowed.<\/li>\n<li>Indicate if the surcharge should not be applied to gratuities (tips). This is important in countries\/regions where it is prohibited to apply charges to tips.<\/li>\n<li>Indicate if the surcharge confirmation screen should be shown. If you hide this screen, regulations require you to provide another form of surcharge disclosure.<\/li>\n<\/ul>\n<p>To configure surcharges:<\/p>\n<ol>\n<li>\n<p>Check the current surcharge configuration (if any) by making a GET request to the <code>\/terminalSettings<\/code> endpoint for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/companies\/(companyId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">company account<\/a>,  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/merchants\/(merchantId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchant account<\/a>,  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/stores\/(storeId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">store<\/a> or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/terminals\/(terminalId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">terminal<\/a>, and checking the <code>surcharge<\/code> object.<\/p>\n<\/li>\n<li>\n<p>Create an overview of all surcharges that you want to apply. For example:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Brand<\/th>\n<th style=\"text-align: left;\">Only commercial cards<\/th>\n<th style=\"text-align: center;\">Funding source<\/th>\n<th style=\"text-align: center;\">Country\/ region<\/th>\n<th style=\"text-align: center;\">Currency<\/th>\n<th style=\"text-align: center;\">Percentage<\/th>\n<th style=\"text-align: center;\">Amount<\/th>\n<th style=\"text-align: center;\">Max. amount<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">eftpos<\/td>\n<td style=\"text-align: left;\">false<\/td>\n<td style=\"text-align: center;\">Debit<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: center;\">AUD<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<td style=\"text-align: center;\">AUD&nbsp;0.10<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Mastercard<\/td>\n<td style=\"text-align: left;\">false<\/td>\n<td style=\"text-align: center;\">Credit<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: center;\">AUD<\/td>\n<td style=\"text-align: center;\">0.58 %<\/td>\n<td style=\"text-align: center;\">AUD&nbsp;1<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Mastercard<\/td>\n<td style=\"text-align: left;\">false<\/td>\n<td style=\"text-align: center;\">Debit<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: center;\">AUD<\/td>\n<td style=\"text-align: center;\">0.58 %<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<td style=\"text-align: center;\">AUD&nbsp;10<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Visa<\/td>\n<td style=\"text-align: left;\">false<\/td>\n<td style=\"text-align: center;\">Credit or Debit<\/td>\n<td style=\"text-align: center;\">AU, NZ<\/td>\n<td style=\"text-align: center;\">AUD<\/td>\n<td style=\"text-align: center;\">0.63 %<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Visa<\/td>\n<td style=\"text-align: left;\">false<\/td>\n<td style=\"text-align: center;\">Credit or Debit<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: center;\">AUD<\/td>\n<td style=\"text-align: center;\">1.63 %<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Visa<\/td>\n<td style=\"text-align: left;\">true<\/td>\n<td style=\"text-align: center;\">Credit or Debit<\/td>\n<td style=\"text-align: center;\">NL<\/td>\n<td style=\"text-align: center;\">EUR<\/td>\n<td style=\"text-align: center;\">1.63 %<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<td style=\"text-align: center;\">(none)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"notices green\">\n<p>Specifying a country\/region applies the surcharge settings only to payment methods issued in that country\/region. If not specified, the surcharge applies to all payment methods that meet the rest of the conditions.<\/p>\n<\/div>\n<\/li>\n<li>\n<p>Make a PATCH request to the <code>\/terminalSettings<\/code> endpoint for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/companies\/(companyId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">company account<\/a>,  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/merchants\/(merchantId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchant account<\/a>,  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/stores\/(storeId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">store<\/a> or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/get\/terminals\/(terminalId)\/terminalSettings\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">terminal<\/a>.<br \/>\nIn the request body, specify a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/patch\/companies\/(companyId)\/terminalSettings#request-surcharge\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">surcharge<\/a> object with the following properties:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Data&nbsp;type<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/patch\/companies\/(companyId)\/terminalSettings#request-surcharge-askConfirmation\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">askConfirmation<\/a><\/td>\n<td style=\"text-align: left;\">Boolean<\/td>\n<td style=\"text-align: left;\">Indicates whether to show (<strong>true<\/strong>) or hide (<strong>false<\/strong>) the <a href=\"#how-it-works\">surcharge confirmation screen<\/a> on the payment terminal.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/patch\/companies\/(companyId)\/terminalSettings#request-surcharge-excludeGratuityFromSurcharge\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">excludeGratuityFromSurcharge<\/a><\/td>\n<td style=\"text-align: left;\">Boolean<\/td>\n<td style=\"text-align: left;\">Indicates whether to apply surcharges only to the purchase amount (<strong>true<\/strong>) or to the total of purchase amount and tip amount (<strong>false<\/strong>). Set this parameter to <strong>true<\/strong> if your country\/region prohibits deducting charges from the tips that customers leave for the employees.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/patch\/companies\/(companyId)\/terminalSettings#request-surcharge-configurations\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">configurations<\/a><\/td>\n<td style=\"text-align: left;\">Array[Object]<\/td>\n<td style=\"text-align: left;\">Array of payment methods for which to apply surcharges. Each payment method is an array item that includes details about how to apply the surcharge. <div class=\"sc-notice note\"><div> The order of array items inside the <code>configurations<\/code> array impacts the order of execution. The condition that is met first is executed without checking the rest of the configuration.<\/div><\/div><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>For each array item in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Management\/latest\/patch\/companies\/(companyId)\/terminalSettings#request-surcharge-configurations\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">configurations<\/a> object, specify:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>brand<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">A payment method <a href=\"\/pt\/development-resources\/paymentmethodvariant#management-api\">supported for Management API<\/a>, for example <code>eftpos_australia<\/code> or <code>mc<\/code>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>currencies<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">An object with: <ul><li markdown=\"1\"><code>currencyCode<\/code>: (required) the three-character <a href=\"\/pt\/development-resources\/currency-codes\">ISO currency code<\/a>.<\/li> <li markdown=\"1\"><code>percentage<\/code>: surcharge percentage per transaction up to two decimal places. For example, 1% or 2.27%.<\/li> <li markdown=\"1\"><code>amount<\/code>: surcharge amount per transaction, in <a href=\"\/pt\/development-resources\/currency-codes\">minor units<\/a>.<\/li> <li markdown=\"1\"><code>maxAmount<\/code>: the maximum surcharge amount per transaction, in <a href=\"\/pt\/development-resources\/currency-codes\">minor units<\/a>.<\/li><\/ul> <br> This object must contain the <code>currencyCode<\/code> and a <code>percentage<\/code> or an <code>amount<\/code> (or both).<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>sources<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Can be: <strong>Credit<\/strong> or <strong>Debit<\/strong>. If not specified, the <code>currencies<\/code> settings apply to all possible funding sources for the <code>brand<\/code>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>country<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The country\/region of the issuer, in <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">two-letter ISO 3166-1 alpha-2<\/a> country code format. If used, the surcharge settings only apply if the payment method was issued in that country\/region.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>commercial<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Set to <strong>true<\/strong> to indicate that the surcharge should be applied only in case of a commercial\/business card. If not specified, the default value <strong>false<\/strong> is used. This setting is important in countries\/regions where a surcharge is not allowed for consumer cards. <div class=\"sc-notice info\"><div>This check is not supported on mobile devices used in a Mobile solution. On payment terminals this check is not supported when the internet connection is down.<\/div><\/div><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Configure surcharges'\" :id=\"'code-sample-configure-surcharges'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/management-test.adyen.com\\\/v3\\\/stores\\\/{storeId}\\\/terminalSettings \\\\\\n-H 'x-API-key: YOUR_X-API-KEY' \\\\\\n-X PATCH \\\\\\n-d '{\\n    \\&quot;surcharge\\&quot;:{\\n        \\&quot;askConfirmation\\&quot;:true,\\n        \\&quot;excludeGratuityFromSurcharge\\&quot;:false,\\n        \\&quot;configurations\\&quot;:[\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;mc\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                    \\&quot;Credit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;AUD\\&quot;,\\n                        \\&quot;percentage\\&quot;:\\&quot;0.58\\&quot;,\\n                        \\&quot;amount\\&quot;:\\&quot;100\\&quot;\\n                    }\\n                ]\\n            },\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;mc\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                    \\&quot;Debit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;AUD\\&quot;,\\n                        \\&quot;percentage\\&quot;:\\&quot;0.58\\&quot;,\\n                        \\&quot;maxAmount\\&quot;:\\&quot;10000\\&quot;\\n                    }\\n                ]\\n            },\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;eftpos\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                   \\&quot;Debit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;AUD\\&quot;,\\n                        \\&quot;amount\\&quot;:\\&quot;10\\&quot;\\n                    }\\n                ]\\n            },\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;visa\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                    \\&quot;Credit\\&quot;,\\n                    \\&quot;Debit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;AUD\\&quot;,\\n                        \\&quot;percentage\\&quot;:\\&quot;0.63\\&quot;\\n                    }\\n                ],\\n                \\&quot;country\\&quot;:[\\n                    \\&quot;AU\\&quot;, \\&quot;NZ\\&quot;\\n                ]\\n            },\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;visa\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                    \\&quot;Credit\\&quot;,\\n                    \\&quot;Debit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;AUD\\&quot;,\\n                        \\&quot;percentage\\&quot;:\\&quot;1.63\\&quot;\\n                    }\\n                ]\\n            },\\n            {\\n                \\&quot;brand\\&quot;:\\&quot;visa\\&quot;,\\n                \\&quot;sources\\&quot;:[\\n                    \\&quot;Credit\\&quot;,\\n                    \\&quot;Debit\\&quot;\\n                ],\\n                \\&quot;currencies\\&quot;:[\\n                    {\\n                        \\&quot;currencyCode\\&quot;:\\&quot;EUR\\&quot;,\\n                        \\&quot;percentage\\&quot;:\\&quot;1.63\\&quot;\\n                    }\\n                ],\\n                \\&quot;country\\&quot;:[\\n                    \\&quot;NL\\&quot;\\n                ],\\n                \\&quot;commercial\\&quot;:true\\n            }\\n        ]\\n    }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>The response returns the surcharge settings as well as all other terminal settings at the level where you made the request.<\/p>\n<\/li>\n<li>\n<p>(Optional) Ask our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to configure <strong>single tap<\/strong>. When this feature is enabled, the customer doesn't need to present their contactless card again after the terminal has calculated the total amount.<\/p>\n<div class=\"notices yellow\">\n<p>When accepting payments with surcharges using Tap to Pay on a mobile device, only the single tap flow is available. Ask our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to configure <strong>single tap<\/strong>.<\/p>\n<\/div>\n<\/li>\n<\/ol>\n<h2>Book the surcharge to your user<\/h2>\n<p>To ensure the automatically calculated surcharge is booked to your user's balance account<\/p>\n<ol>\n<li>\n<p>When you <a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization#gather-data\">gather the split instructions for the payment<\/a>, add a split item for the surcharge:<\/p>\n<ul>\n<li>Increase the <code>split.nrOfItems<\/code> by one, to accommodate the surcharge split item you are adding.<\/li>\n<li>\n<p>In the split item for the surcharge, specify:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Key<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>split.item[ITEM_NUMBER].type<\/code><\/td>\n<td style=\"text-align: left;\">The type of split. Set this to <span translate=\"no\"><strong>Surcharge<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>split.item[ITEM_NUMBER].account<\/code><\/td>\n<td style=\"text-align: left;\">The account that will receive the surcharge. This is the <code>balanceAccountID<\/code> of one of your user's balance accounts.<br><div class=\"notices green\">You cannot split the surcharge between multiple balance accounts.<\/div><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>split.item[ITEM_NUMBER].reference<\/code><\/td>\n<td style=\"text-align: left;\">Your reference for the surcharge, reflected in the <a href=\"\/pt\/platforms\/reports-and-fees\/balance-platform-accounting-report\">Balance Platform Accounting Report<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>split.item[ITEM_NUMBER].description<\/code><\/td>\n<td style=\"text-align: left;\">Your description of the surcharge, reflected in the <a href=\"\/pt\/platforms\/reports-and-fees\/balance-platform-accounting-report\">Balance Platform Accounting Report<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<p>Because the surcharge amount is only calculated after the customer presents their card, you do not need to include a surcharge amount in the <code>split.totalAmount<\/code> field or add a <code>split.item[ITEM_NUMBER].amount<\/code> field for the surcharge.<\/p>\n<\/li>\n<li>\n<p>Format the split data in one of the following ways:<\/p>\n<ul>\n<li><strong>Option 1<\/strong>: as a string of form-encoded key-value pairs (using <strong>&amp;<\/strong> as a separator).<\/li>\n<li><strong>Option 2<\/strong>: as a JSON object converted to a Base64-encoded string.<\/li>\n<\/ul>\n<p>As an example, we use a payment of USD 626.00 that is split into:<\/p>\n<ul>\n<li>USD 600.00 to be booked to your user's first balance account as the sale amount.<\/li>\n<li>USD 20.00 to be booked to your liable account as your platform's commission.<\/li>\n<li>The payment fee to be booked to your user's first balance account. This will be deducted from the sale amount.<\/li>\n<li>USD 6.00 to be booked to your user's first balance account as the surcharge.<\/li>\n<\/ul>\n<p>In this case, the <code>split.nrOfItems<\/code> is <strong>4<\/strong> and the <code>split.totalAmount<\/code> is <strong>62000<\/strong> because the amounts for the payment fee and the surcharge are not known when sending the request.<\/p>\n\n<div id=\"tab7lm9k\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Key-value pairs&quot;,&quot;content&quot;:&quot;\\n&lt;ol&gt;\\n&lt;li&gt;\\n&lt;p&gt;Turn the split data you gathered into key-value pairs.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Split surcharge data as key-value pairs&#039;\\&quot; :id=\\&quot;&#039;split-data-pairs-2&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;raw\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;split.api=1\\\\nsplit.nrOfItems=4\\\\nsplit.totalAmount=62000\\\\nsplit.currencyCode=USD\\\\nsplit.item1.amount=60000\\\\nsplit.item1.type=BalanceAccount\\\\nsplit.item1.account=BA00000000000000000000001\\\\nsplit.item1.reference=Your reference for the sale\\\\nsplit.item1.description=Your description for the sale\\\\nsplit.item2.amount=2000\\\\nsplit.item2.type=Commission\\\\nsplit.item2.reference=Your reference for your commission\\\\nsplit.item2.description=Your description for your commission\\\\nsplit.item3.type=PaymentFee\\\\nsplit.item3.account=BA00000000000000000000001\\\\nsplit.item3.reference=Your reference for the fees\\\\nsplit.item3.description=Your description for the fees\\\\nsplit.item4.type=Surcharge\\\\nsplit.item4.account=BA00000000000000000000001\\\\nsplit.item4.reference=Your reference for the surcharge\\\\nsplit.item4.description=Your description for the surcharge\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Concatenate the key-value pairs into a string by separating them with ampersands (&lt;strong&gt;&amp;amp;&lt;\\\/strong&gt;).&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Concatenated key-value pairs&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;bash\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;split.api=1&amp;amp;split.nrOfItems=4&amp;amp;split.totalAmount=62000&amp;amp;split.currencyCode=USD&amp;amp;split.item1.amount=60000&amp;amp;split.item1.type=BalanceAccount&amp;amp;split.item1.account=BA00000000000000000000001&amp;amp;split.item1.reference=Your reference for the sale&amp;amp;split.item1.description=Your description for the sale&amp;amp;split.item2.amount=2000&amp;amp;split.item2.type=Commission&amp;amp;split.item2.reference=Your reference for your commission&amp;amp;split.item2.description=Your description for your commission&amp;amp;split.item3.type=PaymentFee&amp;amp;split.item3.account=BA00000000000000000000001&amp;amp;split.item3.reference=Your reference for the fees&amp;amp;split.item3.description=Your description for the fees&amp;amp;split.item4.type=Surcharge&amp;amp;split.item4.account=BA00000000000000000000001&amp;amp;split.item4.reference=Your reference for the surcharge&amp;amp;split.item4.description=Your description for the surcharge\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:&quot;split-key-value-pairs&quot;,&quot;oldTabId&quot;:&quot;split-key-value-pairs_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Base64-encoded JSON&quot;,&quot;content&quot;:&quot;\\n&lt;ol&gt;\\n&lt;li&gt;\\n&lt;p&gt;Create a JSON object consisting of an &lt;code&gt;additionalData&lt;\\\/code&gt; object containing the split data you gathered.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;JSON object&#039;\\&quot; :id=\\&quot;&#039;JSON-object_2&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n   \\\\\\&quot;additionalData\\\\\\&quot;: {\\\\n       \\\\\\&quot;split.api\\\\\\&quot;: \\\\\\&quot;1\\\\\\&quot;,\\\\n       \\\\\\&quot;split.nrOfItems\\\\\\&quot;: \\\\\\&quot;4\\\\\\&quot;,\\\\n       \\\\\\&quot;split.totalAmount\\\\\\&quot;: \\\\\\&quot;62000\\\\\\&quot;,\\\\n       \\\\\\&quot;split.currencyCode\\\\\\&quot;: \\\\\\&quot;USD\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item1.amount\\\\\\&quot;: \\\\\\&quot;60000\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item1.type\\\\\\&quot;: \\\\\\&quot;BalanceAccount\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item1.account\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item1.reference\\\\\\&quot;: \\\\\\&quot;Your reference for the sale\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item1.description\\\\\\&quot;: \\\\\\&quot;Your description for the sale\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item2.amount\\\\\\&quot;: \\\\\\&quot;2000\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item2.type\\\\\\&quot;: \\\\\\&quot;Commission\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item2.reference\\\\\\&quot;: \\\\\\&quot;Your reference for your commission\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item2.description\\\\\\&quot;: \\\\\\&quot;Your description for your commission\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item3.type\\\\\\&quot;: \\\\\\&quot;PaymentFee\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item3.account\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item3.reference\\\\\\&quot;: \\\\\\&quot;Your reference for the fees\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item3.description\\\\\\&quot;: \\\\\\&quot;Your description for the fees\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item4.type\\\\\\&quot;: \\\\\\&quot;Surcharge\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item4.account\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item4.reference\\\\\\&quot;: \\\\\\&quot;Your reference for the surcharge\\\\\\&quot;,\\\\n       \\\\\\&quot;split.item4.description\\\\\\&quot;: \\\\\\&quot;Your description for the surcharge\\\\\\&quot;\\\\n   }\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Encode the JSON object to Base64.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Base64 string&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;bash\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;ewogICAiYWRkaXRpb25hbERhdGEiOnsKICAgICAgInNwbGl0LmFwaSI6IjEiLAogICAgICAic3BsaXQubnJPZkl0ZW1zIjoiNCIsCiAgICAgICJzcGxpdC50b3RhbEFtb3VudCI6IjYyMDAwIiwKICAgICAgInNwbGl0LmN1cnJlbmN5Q29kZSI6IkVVUiIsCiAgICAgICJzcGxpdC5pdGVtMS5hbW91bnQiOiI2MDAwMCIsCiAgICAgICJzcGxpdC5pdGVtMS50eXBlIjoiQmFsYW5jZUFjY291bnQiLAogICAgICAic3BsaXQuaXRlbTEuYWNjb3VudCI6IkJBMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDEiLAogICAgICAic3BsaXQuaXRlbTEucmVmZXJlbmNlIjoiWW91ciByZWZlcmVuY2UgZm9yIHRoZSBzYWxlIiwKICAgICAgInNwbGl0Lml0ZW0xLmRlc2NyaXB0aW9uIjoiWW91ciBkZXNjcmlwdGlvbiBvZiB0aGUgc2FsZSIsCiAgICAgICJzcGxpdC5pdGVtMi5hbW91bnQiOiIyMDAwIiwKICAgICAgInNwbGl0Lml0ZW0yLnR5cGUiOiJDb21taXNzaW9uIiwKICAgICAgInNwbGl0Lml0ZW0yLnJlZmVyZW5jZSI6IllvdXIgcmVmZXJlbmNlIGZvciB0aGUgY29tbWlzc2lvbiIsCiAgICAgICJzcGxpdC5pdGVtMi5kZXNjcmlwdGlvbiI6IllvdXIgZGVzY3JpcHRpb24gb2YgdGhlIGNvbW1pc3Npb24iLAogICAgICAic3BsaXQuaXRlbTMudHlwZSI6IlBheW1lbnRGZWUiLAogICAgICAic3BsaXQuaXRlbTMuYWNjb3VudCI6IkJBMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDEiLAogICAgICAic3BsaXQuaXRlbTMucmVmZXJlbmNlIjoiWW91ciByZWZlcmVuY2UgZm9yIHRoZSBmZWVzIiwKICAgICAgInNwbGl0Lml0ZW0zLmRlc2NyaXB0aW9uIjoiWW91ciBkZXNjcmlwdGlvbiBvZiB0aGUgZmVlcyIsCiAgICAgICJzcGxpdC5pdGVtNC50eXBlIjoiU3VyY2hhcmdlIiwKICAgICAgInNwbGl0Lml0ZW00LmFjY291bnQiOiJCQTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAxIiwKICAgICAgInNwbGl0Lml0ZW00LnJlZmVyZW5jZSI6IllvdXIgcmVmZXJlbmNlIGZvciB0aGUgc3VyY2hhcmdlIiwKICAgICAgInNwbGl0Lml0ZW00LmRlc2NyaXB0aW9uIjoiWW91ciBkZXNjcmlwdGlvbiBvZiB0aGUgc3VyY2hhcmdlIgogICB9Cn0=\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:&quot;split-base64-format&quot;,&quot;oldTabId&quot;:&quot;split-base64-format_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<\/li>\n<li>\n<p><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization#splits\">Make a Terminal API payment request<\/a>, passing the formatted string of split instructions in the <code>SaleToAcquirerData<\/code> field of the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">PaymentRequest<\/a> object.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Payment with surcharge split instructions as key-value pairs'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"SaleToPOIRequest\\\": {\\n        \\\"MessageHeader\\\": {\\n            \\\"ProtocolVersion\\\": \\\"3.0\\\",\\n            \\\"MessageClass\\\": \\\"Service\\\",\\n            \\\"MessageCategory\\\": \\\"Payment\\\",\\n            \\\"MessageType\\\": \\\"Request\\\",\\n            \\\"SaleID\\\": \\\"POSSystemID12345\\\",\\n            \\\"ServiceID\\\": \\\"0207111104\\\",\\n            \\\"POIID\\\": \\\"V400m-324688179\\\"\\n        },\\n        \\\"PaymentRequest\\\": {\\n            \\\"SaleData\\\": {\\n                \\\"SaleTransactionID\\\": {\\n                    \\\"TransactionID\\\": \\\"27908\\\",\\n                    \\\"TimeStamp\\\": \\\"2022-10-28T10:11:04+00:00\\\"\\n                },\\n                \\\"SaleToAcquirerData\\\": \\\"split.api=1&amp;split.nrOfItems=4&amp;split.totalAmount=62000&amp;split.currencyCode=USD&amp;split.item1.amount=60000&amp;split.item1.type=BalanceAccount&amp;split.item1.account=BA00000000000000000000001&amp;split.item1.reference=Your reference for the sale&amp;split.item1.description=Your description for the sale&amp;split.item2.amount=2000&amp;split.item2.type=Commission&amp;split.item2.reference=Your reference for your commission&amp;split.item2.description=Your description for your commission&amp;split.item3.type=PaymentFee&amp;split.item3.account=BA00000000000000000000001&amp;split.item3.reference=Your reference for the fees&amp;split.item3.description=Your description for the fees&amp;split.item4.type=Surcharge&amp;split.item4.account=BA00000000000000000000001&amp;split.item4.reference=Your reference for the surcharge&amp;split.item4.description=Your description for the surcharge\\\"\\n            },\\n            \\\"PaymentTransaction\\\": {\\n                \\\"AmountsReq\\\": {\\n                    \\\"Currency\\\": \\\"USD\\\",\\n                    \\\"RequestedAmount\\\": 620.00\\n                }\\n            }\\n        }\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/terminal-api\/latest\/post\/payment#responses-200\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">PaymentResponse<\/a> note the following:<\/p>\n<ul>\n<li><code>POIData.POITransactionID.TransactionID<\/code>: The <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api#transaction-identifier\">transaction identifier<\/a> in the format <em>tenderReference.pspReference<\/em>. Use the PSP reference to keep track of the payment.<\/li>\n<li><code>PaymentResult.AmountsResp<\/code>:\n<ul>\n<li><code>TotalFeesAmount<\/code>: The surcharge amount.<\/li>\n<li><code>AuthorizedAmount<\/code>: The total authorized amount, consisting of the original amount plus the surcharge amount.<\/li>\n<\/ul><\/li>\n<li>\n<p><code>Response.AdditionalResponse<\/code>:<\/p>\n<ul>\n<li><code>posAuthAmountValue<\/code>: The total authorized amount in <a href=\"\/pt\/development-resources\/currency-codes\">minor units<\/a>.<\/li>\n<li>\n<p><code>surchargeAmount<\/code>: The surcharge amount in minor units.<\/p>\n<!-- list separator -->\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'response-surcharge-split'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n   \\\"SaleToPOIResponse\\\":{\\n      \\\"MessageHeader\\\":{},\\n      \\\"PaymentResponse\\\":{\\n         \\\"POIData\\\":{\\n            \\\"POIReconciliationID\\\":\\\"1000\\\",\\n            \\\"POITransactionID\\\":{\\n               \\\"TimeStamp\\\":\\\"2023-04-12T10:49:53.949Z\\\",\\n               \\\"TransactionID\\\":\\\"qwiT001681296593002.RJTPF68B2HXXGN82\\\"\\n            }\\n         },\\n         \\\"PaymentReceipt\\\":[...],\\n         \\\"PaymentResult\\\":{\\n            \\\"AmountsResp\\\":{\\n               \\\"AuthorizedAmount\\\":626.00,\\n               \\\"Currency\\\":\\\"USD\\\"\\n            },\\n            ...\\n            \\\"PaymentInstrumentData\\\":{...}\\n         },\\n         \\\"Response\\\":{\\n            \\\"AdditionalResponse\\\":\\\"....posAuthAmountCurrency=USD&amp;posAuthAmountValue=62600&amp;posOriginalAmountValue=62000...\\\",\\n\\n            \\\"Result\\\":\\\"Success\\\"\\n         },\\n         \\\"SaleData\\\":{\\n            \\\"SaleTransactionID\\\":{\\n               \\\"TimeStamp\\\":\\\"2023-04-12T10:49:53.996Z\\\",\\n               \\\"TransactionID\\\":\\\"499\\\"\\n            }\\n         }\\n      }\\n   }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"opt-out-moto-mke\">Opting out for MOTO and MKE<\/h2>\n<p>With terminal software version <strong>v1.117<\/strong> and later, the surcharge configuration that you set up also applies to <a href=\"\/pt\/point-of-sale\/mail-and-telephone-order-moto\">Mail Order\/Telephone Order<\/a> (MOTO) and <a href=\"\/pt\/point-of-sale\/enter-payment-manually\">Manual Key Entry<\/a> (MKE) payments.<\/p>\n<p>If you have previously developed your own solution for surcharging MOTO and MKE payments, there is a risk of double surcharging: once through the surcharge configuration, and once through your own solution. To avoid this issue, you can opt out of the Adyen surcharge feature for MOTO and MKE payments. You can set this on any level: company account, merchant account, store, or individual payment terminals.<\/p>\n<p>Reach out to your Adyen account manager or technical contact if you want to opt out.<\/p>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/development-resources\/surcharge-compliance\"\n                        target=\"_self\"\n                        >\n                    Surcharge compliance guide\n                <\/a><\/li><li><a href=\"\/platforms\/in-person-payments\/surcharge\/dynamic\"\n                        target=\"_self\"\n                        >\n                    Dynamic surcharge\n                <\/a><\/li><li><a href=\"\/point-of-sale\/aid-selection-rules\"\n                        target=\"_self\"\n                        >\n                    Card application selection\n                <\/a><\/li><li><a href=\"\/point-of-sale\/automating-terminal-management\/configure-terminals-api\"\n                        target=\"_self\"\n                        >\n                    Use API calls to configure terminals\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments\/surcharge\/configuration","articleFields":{"description":"Define rules for surcharge amounts or percentages, and when to apply them.","parameters":{"model":"platform","channel":"pos","directoryPath":"\/platforms","ippPath":"\/platforms\/in-person-payments"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments\/surcharge\/configuration","title":"Configuration-based surcharge","content":"Using Management API settings, you can configure surcharge rules for your Adyen company or merchant account, store, or individual terminals. Your rules need to take into account all applicable compliance requirements and aspects such as payment method (card brand), funding source, issuing country, and currency.\nBased on the rules you configured, surcharges are then automatically calculated and applied to your in-person payments.  In your payment requests, you can use split instructions to define how to book the surcharge amount. \nDepending on your use case, you can combine configuration-based surcharge with dynamic surcharge.\nRequirements\nIn addition to the general requirements for in-person payments with an Adyen for Platforms integration and the general surcharge requirements, take into account the following information.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nConfiguration-based surcharge is supported with: A Terminal API integration with payment terminals or with a Tap to Pay Mobile solution. A standalone solution. When using payment terminals, note the required terminal software version: v1.108 to apply a maximum surcharge amount per transaction. v1.112 to differentiate between commercial and consumer cards. v1.115 to exclude gratuities (tips) from surcharging. v1.117 to apply surcharges to Mail Order\/Telephone Order (MOTO) and Manual Key Entry (MKE) payments.\n\n\nAPI credentials\nYou must have an API credential with an API key and the following roles: Management API\u2014Terminal settings read Management API\u2014Terminal settings read and write If you have a Terminal API integration with cloud-based communications, you can use the existing API key that you use for Terminal API requests.\n\n\nWebhooks\nIt is recommended to subscribe to Standard webhooks and enable receiving the surcharge amount in AUTHORISATION webhook messages.\n\n\nHardware\nConfiguration-based surcharge is not supported with SFO1 terminals or with NYC1 card readers (in a Mobile solution).\n\n\nLimitations\nNote the following: For surcharges on Tap to Pay transactions, the surcharge confirmation screen does not show. Requests to live Management API endpoints related to terminal settings are subject to rate limits.\n\n\nSetup steps\nFor surcharges on Tap to Pay transactions, ask our Support Team to enable single tap.\n\n\n\nHow it works\nAfter the surcharge amounts and\/or percentages are configured:\n\n\nYou make a payment request like you normally do. There are no special parameters required to trigger the surcharge.\n\n\nThe payment terminal or mobile device shows a screen with the purchase amount and instructs  your user's customer  to present their card.\n\n\nBased on the card that the customer presents, the terminal or Mobile SDK calculates the surcharge using the surcharge amounts and\/or percentages you configured.\n\n\nDepending on your configuration and solution, the surcharge confirmation screen appears. This enables  your user's customer  to accept the surcharge, or cancel the transaction.\n\nIn a Mobile solution or if you choose to skip the confirmation screen, you must provide another form of disclosure.\n\n\n\nIf  your user's customer  accepts the surcharge, the payment is processed and the payment response shows the surcharge amount in the TotalFeesAmount field.\n\n\nConfigure surcharges\nThe payment acceptance fee charged to your user depends on the payment method brand (scheme), funding source (credit or debit), currency, and the country\/region that issued the payment method (domestic or international). Therefore, the surcharge that your user passes on to the customer must be specific for the combination of brand, funding source, currency, and country\/region.\nThe surcharge can be a fixed amount for each transaction, a percentage of the sum of the purchase amount and the tip, or both a fixed amount and a percentage. You can configure the surcharge logic for payments based on the agreements you have with your users.\nIn addition, you can:\n\nSpecify a maximum surcharge amount.\nIndicate if the surcharge should only be applied if the payment method is a commercial\/business card. This is important in countries\/regions where surcharges on consumer cards are not allowed.\nIndicate if the surcharge should not be applied to gratuities (tips). This is important in countries\/regions where it is prohibited to apply charges to tips.\nIndicate if the surcharge confirmation screen should be shown. If you hide this screen, regulations require you to provide another form of surcharge disclosure.\n\nTo configure surcharges:\n\n\nCheck the current surcharge configuration (if any) by making a GET request to the \/terminalSettings endpoint for the  company account,  merchant account,  store or  terminal, and checking the surcharge object.\n\n\nCreate an overview of all surcharges that you want to apply. For example:\n\n\n\nBrand\nOnly commercial cards\nFunding source\nCountry\/ region\nCurrency\nPercentage\nAmount\nMax. amount\n\n\n\n\neftpos\nfalse\nDebit\n\nAUD\n(none)\nAUD&nbsp;0.10\n(none)\n\n\nMastercard\nfalse\nCredit\n\nAUD\n0.58 %\nAUD&nbsp;1\n(none)\n\n\nMastercard\nfalse\nDebit\n\nAUD\n0.58 %\n(none)\nAUD&nbsp;10\n\n\nVisa\nfalse\nCredit or Debit\nAU, NZ\nAUD\n0.63 %\n(none)\n(none)\n\n\nVisa\nfalse\nCredit or Debit\n\nAUD\n1.63 %\n(none)\n(none)\n\n\nVisa\ntrue\nCredit or Debit\nNL\nEUR\n1.63 %\n(none)\n(none)\n\n\n\n\nSpecifying a country\/region applies the surcharge settings only to payment methods issued in that country\/region. If not specified, the surcharge applies to all payment methods that meet the rest of the conditions.\n\n\n\nMake a PATCH request to the \/terminalSettings endpoint for the  company account,  merchant account,  store or  terminal.\nIn the request body, specify a  surcharge object with the following properties:\n\n\n\nParameter\nData&nbsp;type\nDescription\n\n\n\n\n askConfirmation\nBoolean\nIndicates whether to show (true) or hide (false) the surcharge confirmation screen on the payment terminal.\n\n\n excludeGratuityFromSurcharge\nBoolean\nIndicates whether to apply surcharges only to the purchase amount (true) or to the total of purchase amount and tip amount (false). Set this parameter to true if your country\/region prohibits deducting charges from the tips that customers leave for the employees.\n\n\n configurations\nArray[Object]\nArray of payment methods for which to apply surcharges. Each payment method is an array item that includes details about how to apply the surcharge.  The order of array items inside the configurations array impacts the order of execution. The condition that is met first is executed without checking the rest of the configuration.\n\n\n\nFor each array item in the  configurations object, specify:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nbrand\n\nA payment method supported for Management API, for example eftpos_australia or mc.\n\n\ncurrencies\n\nAn object with: currencyCode: (required) the three-character ISO currency code. percentage: surcharge percentage per transaction up to two decimal places. For example, 1% or 2.27%. amount: surcharge amount per transaction, in minor units. maxAmount: the maximum surcharge amount per transaction, in minor units.  This object must contain the currencyCode and a percentage or an amount (or both).\n\n\nsources\n\nCan be: Credit or Debit. If not specified, the currencies settings apply to all possible funding sources for the brand.\n\n\ncountry\n\nThe country\/region of the issuer, in two-letter ISO 3166-1 alpha-2 country code format. If used, the surcharge settings only apply if the payment method was issued in that country\/region.\n\n\ncommercial\n\nSet to true to indicate that the surcharge should be applied only in case of a commercial\/business card. If not specified, the default value false is used. This setting is important in countries\/regions where a surcharge is not allowed for consumer cards. This check is not supported on mobile devices used in a Mobile solution. On payment terminals this check is not supported when the internet connection is down.\n\n\n\n\n\n\nThe response returns the surcharge settings as well as all other terminal settings at the level where you made the request.\n\n\n(Optional) Ask our Support Team to configure single tap. When this feature is enabled, the customer doesn't need to present their contactless card again after the terminal has calculated the total amount.\n\nWhen accepting payments with surcharges using Tap to Pay on a mobile device, only the single tap flow is available. Ask our Support Team to configure single tap.\n\n\n\nBook the surcharge to your user\nTo ensure the automatically calculated surcharge is booked to your user's balance account\n\n\nWhen you gather the split instructions for the payment, add a split item for the surcharge:\n\nIncrease the split.nrOfItems by one, to accommodate the surcharge split item you are adding.\n\nIn the split item for the surcharge, specify:\n\n\n\nKey\nDescription\n\n\n\n\nsplit.item[ITEM_NUMBER].type\nThe type of split. Set this to Surcharge.\n\n\nsplit.item[ITEM_NUMBER].account\nThe account that will receive the surcharge. This is the balanceAccountID of one of your user's balance accounts.You cannot split the surcharge between multiple balance accounts.\n\n\nsplit.item[ITEM_NUMBER].reference\nYour reference for the surcharge, reflected in the Balance Platform Accounting Report.\n\n\nsplit.item[ITEM_NUMBER].description\nYour description of the surcharge, reflected in the Balance Platform Accounting Report.\n\n\n\n\n\nBecause the surcharge amount is only calculated after the customer presents their card, you do not need to include a surcharge amount in the split.totalAmount field or add a split.item[ITEM_NUMBER].amount field for the surcharge.\n\n\nFormat the split data in one of the following ways:\n\nOption 1: as a string of form-encoded key-value pairs (using &amp; as a separator).\nOption 2: as a JSON object converted to a Base64-encoded string.\n\nAs an example, we use a payment of USD 626.00 that is split into:\n\nUSD 600.00 to be booked to your user's first balance account as the sale amount.\nUSD 20.00 to be booked to your liable account as your platform's commission.\nThe payment fee to be booked to your user's first balance account. This will be deducted from the sale amount.\nUSD 6.00 to be booked to your user's first balance account as the surcharge.\n\nIn this case, the split.nrOfItems is 4 and the split.totalAmount is 62000 because the amounts for the payment fee and the surcharge are not known when sending the request.\n\n\n    \n        \n        \n    \n\n\n\n\nMake a Terminal API payment request, passing the formatted string of split instructions in the SaleToAcquirerData field of the  PaymentRequest object.\n\n\n\n\n\nIn the  PaymentResponse note the following:\n\nPOIData.POITransactionID.TransactionID: The transaction identifier in the format tenderReference.pspReference. Use the PSP reference to keep track of the payment.\nPaymentResult.AmountsResp:\n\nTotalFeesAmount: The surcharge amount.\nAuthorizedAmount: The total authorized amount, consisting of the original amount plus the surcharge amount.\n\n\nResponse.AdditionalResponse:\n\nposAuthAmountValue: The total authorized amount in minor units.\n\nsurchargeAmount: The surcharge amount in minor units.\n\n\n\n\n\n\n\n\n\n\nOpting out for MOTO and MKE\nWith terminal software version v1.117 and later, the surcharge configuration that you set up also applies to Mail Order\/Telephone Order (MOTO) and Manual Key Entry (MKE) payments.\nIf you have previously developed your own solution for surcharging MOTO and MKE payments, there is a risk of double surcharging: once through the surcharge configuration, and once through your own solution. To avoid this issue, you can opt out of the Adyen surcharge feature for MOTO and MKE payments. You can set this on any level: company account, merchant account, store, or individual payment terminals.\nReach out to your Adyen account manager or technical contact if you want to opt out.\nSee also\n\n\n                    Surcharge compliance guide\n                \n                    Dynamic surcharge\n                \n                    Card application selection\n                \n                    Use API calls to configure terminals\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Platforms","lvl2":"Process in-person payments","lvl3":"Surcharge","lvl4":"Configuration-based surcharge"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments","lvl3":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments\/surcharge","lvl4":"\/pt\/platforms\/in-person-payments\/surcharge\/configuration"},"levels":5,"category":"Platforms","category_color":"green","tags":["Configuration-based","surcharge"]}}
