{"title":"Automatically split payments in stores","category":"Classic Platforms","creationDate":1776961628,"content":"<div class=\"sc-notice info\"><div>\n<p>This page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our <a href=\"\/pt\/adyen-for-platforms-model\">new integration guide<\/a> instead.<\/p>\n<\/div><\/div>\n<p>When processing payments through stores, you can configure the store to automatically apply your billing logic for your commission fees. This means that you no longer need to send split instructions in every payment or capture request.<\/p>\n<p>For Adyen to automatically apply split instructions, you'll need to:<\/p>\n<ol>\n<li><a href=\"#create-split-configuration\">Create a split configuration<\/a> that contains commission fees and transaction conditions.<\/li>\n<li><a href=\"#create-update-store\">Create or update the store<\/a> to add the split configuration and the account to which the split amount must be sent.<\/li>\n<\/ol>\n<h2>How split configuration works<\/h2>\n<p>A split configuration contains one or more rules that define commission fees and conditions when the fee applies. You create and manage split configurations in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<p>Each rule in a split configuration must have:<\/p>\n<ul>\n<li>Commission fees. The fee can be a fixed amount, a percentage, or both.<\/li>\n<li>Conditions for the rule. You must define a value for each of the following conditions.\n<ul>\n<li><em>Channel<\/em>: The sales channel. This can be a specific channel (such as ecommerce) or any sales channel.<\/li>\n<li><em>Currency<\/em>: Can be specific or any currency.<\/li>\n<li><em>Payment method<\/em>: Can be specific, based on the funding source or any payment method available to the store.<\/li>\n<\/ul><\/li>\n<\/ul>\n<p>A transaction must meet all conditions before the rule can be applied. When a transaction meets all conditions, Adyen applies the corresponding commission fee. We recommend that you include a catchall rule (set all conditions to <em>any<\/em>), because if none of the rules apply to the transaction, then all the funds will go to the liable account.<\/p>\n<p>Adyen evaluates the rules in the split configuration for all the transactions processed through the store. If you need to change the commission fees for specific transactions, you can send <a href=\"\/pt\/classic-platforms\/processing-payments#providing-split-instructions\">split instructions in the payment or capture API request<\/a>. Any split instruction that you send through the API overrides the automatic split.<\/p>\n<h3>Rule hierarchy<\/h3>\n<p>If a split configuration has multiple rules and more than one rule applies to the transaction, Adyen applies the fee from the rule with the highest priority. The rules are prioritized based on the following hierarchy:<\/p>\n<ol>\n<li>Currency<\/li>\n<li>Payment method<\/li>\n<li>Funding source (debit or credit)<\/li>\n<li>Channel<\/li>\n<\/ol>\n<h4>Examples<\/h4>\n<p>Let's take for example the following split configuration rules.<\/p>\n<table>\n<thead>\n<tr>\n<th><\/th>\n<th>Currency<\/th>\n<th>Payment method<\/th>\n<th>Channel<\/th>\n<th>Fee<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>EUR<\/td>\n<td>Any<\/td>\n<td>Any<\/td>\n<td>EUR 3.00 + 1%<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Any<\/td>\n<td>Any<\/td>\n<td>Ecommerce<\/td>\n<td>USD 2.50 + 1%<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>EUR<\/td>\n<td>Visa<\/td>\n<td>Any<\/td>\n<td>EUR 2.00 + 1%<\/td>\n<\/tr>\n<tr>\n<td>4<\/td>\n<td>EUR<\/td>\n<td>Any<\/td>\n<td>Ecommerce<\/td>\n<td>EUR 1.40 + 1%<\/td>\n<\/tr>\n<tr>\n<td>5<\/td>\n<td>EUR<\/td>\n<td>credit_only<\/td>\n<td>Any<\/td>\n<td>EUR 1.50 + 1%<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><strong>Scenario 1<\/strong><br \/>\nAn <em>ecommerce<\/em> transaction  in <em>EUR<\/em>, using <em>American Express<\/em>.<\/p>\n<p>The transaction meets the conditions for rules 1, 2, 4 and 5, but rule 5 has the highest priority because it matches the specific currency (<em>EUR<\/em>) and funding source (credit). Adyen splits the transaction and sends EUR 1.50 + 1% to your liable account.<\/p>\n<p><strong>Scenario 2<\/strong><\/p>\n<p>An <em>ecommerce<\/em> transaction in <em>EUR<\/em>, using <em>Visa<\/em>.<\/p>\n<p>The transaction meets the conditions for all the rules, but rule 3 has the highest priority because of the combination of specific currency (<em>EUR<\/em>) and payment method (<em>Visa<\/em>). Rule 3 has higher priority than rule 2 with the specific currency (<em>EUR<\/em>) and channel (<em>ecommerce<\/em>). Adyen splits the transaction and sends EUR 2.00 + 1% to your liable account.<\/p>\n<h2>Requirements<\/h2>\n<ol>\n<li>Check if you have an integration that uses <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Account\/latest\/post\/updateAccountHolder__resParam_accountHolderDetails-storeDetails\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">stores<\/a>. Stores are currently available only for <a href=\"\/pt\/classic-platforms\/platforms-for-pos\">point of sale<\/a> and <a href=\"\/pt\/classic-platforms\/platforms-for-partners\">partner platforms<\/a> integrations.<\/li>\n<li>Contact 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 split configuration for your platform.<\/li>\n<li>Make sure that you have the <strong>Manage split configuration settings<\/strong> role for your Customer Area user.<\/li>\n<\/ol>\n<h2 id=\"create-split-configuration\">Step 1: Create a split configuration<\/h2>\n<p>Now that you know <a href=\"#how-split-configuration-works\">how split configurations work<\/a>, you can create and manage split configurations in your Customer Area. To access the page, make sure your Customer Area user has the <strong>Manage split configuration settings<\/strong> role.<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> and switch to your merchant account.<\/li>\n<li>Go to <strong>Platform<\/strong> &gt; <strong>Split configuration<\/strong>.<\/li>\n<li>Select the <strong>Add configuration profile<\/strong> button.<\/li>\n<li>Specify a name for the configuration.<\/li>\n<li>Select the <strong>Create<\/strong> button.<\/li>\n<\/ol>\n<p>The new configuration will have a UUID under the configuration name. Take note of this because you'll use this later to <a href=\"#create-update-store\">create or update the store<\/a>.<\/p>\n<p>To add rules to a split configuration:<\/p>\n<ol>\n<li>Go to <strong>Platform<\/strong> &gt; <strong>Split configuration<\/strong>.<\/li>\n<li>Find the specific profile and select the <strong>+<\/strong> button to see the configuration panel.<\/li>\n<li>Select the <strong>Add rule<\/strong> button.<\/li>\n<li>Configure the <strong>Channel<\/strong>, <strong>Scheme<\/strong> (payment method), <strong>Currency<\/strong>, <strong>Fixed Fee<\/strong>, and <strong>Variable Fee<\/strong>. Select the values from the dropdown list.<\/li>\n<li>Select the <strong>Create<\/strong> button.<\/li>\n<\/ol>\n<p>The combination of <strong>Channel<\/strong>, <strong>Scheme<\/strong>, and <strong>Currency<\/strong> must be unique for each rule.<\/p>\n<h2 id=\"create-update-store\">Step 2: Create or update the store<\/h2>\n<p>Make a POST <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Account\/updateAccountHolder\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/updateAccountHolder<\/a> request to add the split configuration. In your request, include the following in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Account\/latest\/post\/updateAccountHolder#request-accountHolderDetails-storeDetails\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">storeDetails<\/a> array:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Account\/latest\/post\/updateAccountHolder#request-accountHolderDetails-storeDetails-splitConfigurationUUID\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">splitConfigurationUUID<\/a>&#58; The UUID of the split configuration from your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Account\/latest\/post\/updateAccountHolder__reqParam_accountHolderDetails-storeDetails-virtualAccount\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">virtualAccount<\/a>: The account holder's <code>accountCode<\/code> to which the split amount will be sent.<\/li>\n<\/ul>\n<p>The following example shows how to update an account holder to create a store with a split configuration.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Add store with split configuration to an account holder'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/cal-test.adyen.com\\\/cal\\\/services\\\/Account\\\/v6\\\/updateAccountHolder \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n  \\&quot;accountHolderCode\\&quot;:\\&quot;UNIQUE_ACCOUNT_HOLDER_CODE\\&quot;,\\n  \\&quot;accountHolderDetails\\&quot;: {\\n    \\&quot;storeDetails\\&quot;: [\\n      {\\n        \\&quot;merchantAccount\\&quot;: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n        \\&quot;merchantCategoryCode\\&quot;: \\&quot;5999\\&quot;,\\n        \\&quot;fullPhoneNumber\\&quot;: \\&quot;+14153671502\\&quot;,\\n        \\&quot;virtualAccount\\&quot;: \\&quot;1211992213193029\\&quot;,\\n        \\&quot;splitConfigurationUUID\\&quot;: \\&quot;c52bb45f-0ada-4e55-af04-df5bf637bf49\\&quot;,\\n        \\&quot;storeName\\&quot;: \\&quot;STORE_NAME\\&quot;,\\n        \\&quot;storeReference\\&quot;: \\&quot;YOUR_STORE_REFERENCE\\&quot;,\\n        \\&quot;address\\&quot;: {\\n          \\&quot;city\\&quot;: \\&quot;San Francisco\\&quot;,\\n          \\&quot;country\\&quot;: \\&quot;US\\&quot;,\\n          \\&quot;postalCode\\&quot;: \\&quot;94107\\&quot;,\\n          \\&quot;stateOrProvince\\&quot;: \\&quot;CA\\&quot;,\\n          \\&quot;street\\&quot;: \\&quot;Brannan Street\\&quot;,\\n          \\&quot;houseNumberOrName\\&quot;: \\&quot;274\\&quot;\\n        }\\n      }\\n    ]\\n  }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>If the store already exists, you can update the store entry to add the split configuration.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Add split configuration to account holder with existing store'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/cal-test.adyen.com\\\/cal\\\/services\\\/Account\\\/v6\\\/updateAccountHolder \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n  \\&quot;accountHolderCode\\&quot;:\\&quot;UNIQUE_ACCOUNT_HOLDER_CODE\\&quot;,\\n  \\&quot;accountHolderDetails\\&quot;: {\\n    \\&quot;storeDetails\\&quot;: [\\n      {\\n        \\&quot;splitConfigurationUUID\\&quot;: \\&quot;53da2e8e-1d38-11eb-adc1-0242ac120002\\&quot;,\\n        \\&quot;virtualAccount\\&quot;: \\&quot;1211992213193029\\&quot;,\\n        \\&quot;store\\&quot;: \\&quot;47cec6d6-725a-40b4-b8cc-3245a66c1ed4\\&quot;\\n      }\\n    ]\\n  }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>Requests using <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Account\/updateAccountHolder\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/updateAccountHolder<\/a> are processed asynchronously. You'll receive a response to your API request, but you must rely on the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_UPDATED\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_UPDATED<\/a> notification webhook to know the final result of your request.<\/p>\n<p>After the store is successfully created or updated, Adyen starts evaluating every transaction processed in the store and applies the split configuration rules.<\/p>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/classic-platforms\/platforms-for-pos\"\n                        target=\"_self\"\n                        >\n                    Point of sale for platforms\n                <\/a><\/li><li><a href=\"\/classic-platforms\/platforms-for-partners\"\n                        target=\"_self\"\n                        >\n                    Partner platforms\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/split-configuration-for-stores","articleFields":{"description":"Split payments automatically when processing through stores.","search_category":"Classic Platforms","feedback_component":true,"id":"25142910","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"28-12-2021 10:37","parameters":{"directoryPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/split-configuration-for-stores","title":"Automatically split payments in stores","content":"\nThis page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our new integration guide instead.\n\nWhen processing payments through stores, you can configure the store to automatically apply your billing logic for your commission fees. This means that you no longer need to send split instructions in every payment or capture request.\nFor Adyen to automatically apply split instructions, you'll need to:\n\nCreate a split configuration that contains commission fees and transaction conditions.\nCreate or update the store to add the split configuration and the account to which the split amount must be sent.\n\nHow split configuration works\nA split configuration contains one or more rules that define commission fees and conditions when the fee applies. You create and manage split configurations in your Customer Area.\nEach rule in a split configuration must have:\n\nCommission fees. The fee can be a fixed amount, a percentage, or both.\nConditions for the rule. You must define a value for each of the following conditions.\n\nChannel: The sales channel. This can be a specific channel (such as ecommerce) or any sales channel.\nCurrency: Can be specific or any currency.\nPayment method: Can be specific, based on the funding source or any payment method available to the store.\n\n\nA transaction must meet all conditions before the rule can be applied. When a transaction meets all conditions, Adyen applies the corresponding commission fee. We recommend that you include a catchall rule (set all conditions to any), because if none of the rules apply to the transaction, then all the funds will go to the liable account.\nAdyen evaluates the rules in the split configuration for all the transactions processed through the store. If you need to change the commission fees for specific transactions, you can send split instructions in the payment or capture API request. Any split instruction that you send through the API overrides the automatic split.\nRule hierarchy\nIf a split configuration has multiple rules and more than one rule applies to the transaction, Adyen applies the fee from the rule with the highest priority. The rules are prioritized based on the following hierarchy:\n\nCurrency\nPayment method\nFunding source (debit or credit)\nChannel\n\nExamples\nLet's take for example the following split configuration rules.\n\n\n\n\nCurrency\nPayment method\nChannel\nFee\n\n\n\n\n1\nEUR\nAny\nAny\nEUR 3.00 + 1%\n\n\n2\nAny\nAny\nEcommerce\nUSD 2.50 + 1%\n\n\n3\nEUR\nVisa\nAny\nEUR 2.00 + 1%\n\n\n4\nEUR\nAny\nEcommerce\nEUR 1.40 + 1%\n\n\n5\nEUR\ncredit_only\nAny\nEUR 1.50 + 1%\n\n\n\nScenario 1\nAn ecommerce transaction  in EUR, using American Express.\nThe transaction meets the conditions for rules 1, 2, 4 and 5, but rule 5 has the highest priority because it matches the specific currency (EUR) and funding source (credit). Adyen splits the transaction and sends EUR 1.50 + 1% to your liable account.\nScenario 2\nAn ecommerce transaction in EUR, using Visa.\nThe transaction meets the conditions for all the rules, but rule 3 has the highest priority because of the combination of specific currency (EUR) and payment method (Visa). Rule 3 has higher priority than rule 2 with the specific currency (EUR) and channel (ecommerce). Adyen splits the transaction and sends EUR 2.00 + 1% to your liable account.\nRequirements\n\nCheck if you have an integration that uses stores. Stores are currently available only for point of sale and partner platforms integrations.\nContact our Support Team to enable split configuration for your platform.\nMake sure that you have the Manage split configuration settings role for your Customer Area user.\n\nStep 1: Create a split configuration\nNow that you know how split configurations work, you can create and manage split configurations in your Customer Area. To access the page, make sure your Customer Area user has the Manage split configuration settings role.\n\nLog in to your Customer Area and switch to your merchant account.\nGo to Platform &gt; Split configuration.\nSelect the Add configuration profile button.\nSpecify a name for the configuration.\nSelect the Create button.\n\nThe new configuration will have a UUID under the configuration name. Take note of this because you'll use this later to create or update the store.\nTo add rules to a split configuration:\n\nGo to Platform &gt; Split configuration.\nFind the specific profile and select the + button to see the configuration panel.\nSelect the Add rule button.\nConfigure the Channel, Scheme (payment method), Currency, Fixed Fee, and Variable Fee. Select the values from the dropdown list.\nSelect the Create button.\n\nThe combination of Channel, Scheme, and Currency must be unique for each rule.\nStep 2: Create or update the store\nMake a POST \/updateAccountHolder request to add the split configuration. In your request, include the following in the  storeDetails array:\n\n splitConfigurationUUID&#58; The UUID of the split configuration from your Customer Area.\nvirtualAccount: The account holder's accountCode to which the split amount will be sent.\n\nThe following example shows how to update an account holder to create a store with a split configuration.\n\n    \n\nIf the store already exists, you can update the store entry to add the split configuration.\n\n    \n\nRequests using \/updateAccountHolder are processed asynchronously. You'll receive a response to your API request, but you must rely on the  ACCOUNT_HOLDER_UPDATED notification webhook to know the final result of your request.\nAfter the store is successfully created or updated, Adyen starts evaluating every transaction processed in the store and applies the split configuration rules.\nSee also\n\n\n                    Point of sale for platforms\n                \n                    Partner platforms\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Automatically split payments in stores"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/classic-platforms","lvl2":"\/pt\/classic-platforms\/split-configuration-for-stores"},"levels":3,"category":"Classic Platforms","category_color":"green","tags":["Automatically","split","payments","stores"]}}
