{"title":"Split transactions between balance accounts","category":"default","creationDate":1676564580,"content":"<p>To make sure that the pay-in, settlement, and payout processes run smoothly for all users' transactions, you must book the funds and fees to the correct balance accounts.<\/p>\n<p>This means that you must define instructions about how to split the funds between your user's balance accounts and your platform's liable balance account. You can define these instructions in the following ways:<\/p>\n<ul>\n<li>Automatically split all transactions processed through your user's store by setting up <a href=\"\/pt\/platforms\/automatic-split-configuration\">split configuration profiles<\/a>.<\/li>\n<li>Split transactions by defining instructions for each API request. The instructions you provide in your API requests override the instructions you defined in your split configuration profiles.<\/li>\n<\/ul>\n<p>If you do not provide any split instructions in a split configuration profile or through an API request, the whole transaction amount and fees are booked to your liable balance account.<\/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, take into account the following requirement.<\/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;\">A <a href=\"\/pt\/point-of-sale\/design-your-integration\/terminal-api\">Terminal API<\/a> integration with <a href=\"\/pt\/point-of-sale\/what-we-support\/select-your-terminals\">payment terminals<\/a> or with a <a href=\"\/pt\/point-of-sale\/ipp-mobile\">Mobile solution<\/a>. <div class=\"notices green\">The standalone solution does not support adding split instructions to individual payments or refunds<\/div><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Split specific transactions<\/h2>\n<p>If you want to define separate instructions for specific transactions in your platform, you can define the split instructions in your API requests. The instructions you provide in your API requests override any <a href=\"\/pt\/platforms\/automatic-split-configuration\">automatic split configuration profiles<\/a> applied to your user's store.<\/p>\n<p>The following information on this page explains the process of defining split instructions for specific transactions. Before sending an API request with split instructions, make sure you understand:<\/p>\n<ul>\n<li><a href=\"#when-to-provide-split-instructions\">When to provide split instructions<\/a><\/li>\n<li><a href=\"#how-to-split-a-transaction\">How you can split a transaction<\/a><\/li>\n<li><a href=\"#send-split-instructions\">How to send split instructions<\/a><\/li>\n<li><a href=\"#split-types\">Which split types you can include in your request<\/a><\/li>\n<\/ul>\n<h2>When to provide split instructions<\/h2>\n<p>You can provide instructions to split payments when you make the following requests:<\/p>\n<ul>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization\">A Terminal API payment request<\/a> to authorize a payment.<\/li>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-capture\">A Checkout API <code>\/captures<\/code> request<\/a> to capture a payment.<\/li>\n<\/ul>\n<p>You can provide instructions to split refunds when you make the following request:<\/p>\n<ul>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-refunds\">A Terminal API referenced refund request<\/a><\/li>\n<\/ul>\n<p>This means that for every individual authorization, capture, or refund request that occurs in your platform, you can determine how to book the funds from that transaction.<\/p>\n<h2>How to split a transaction<\/h2>\n<p>When you process transactions for your users, you can split the funds and book them to any number of balance accounts in your platform.<\/p>\n\n<div id=\"tabF9eyH\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Payments&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;For payments, you can provide split instructions for booking:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;The sale amount for the goods or services&lt;\\\/li&gt;\\n&lt;li&gt;Your platform&#039;s commission for the payment&lt;\\\/li&gt;\\n&lt;li&gt;&lt;a href=\\&quot;\\\/pt\\\/platforms\\\/in-person-payments\\\/transaction-fees\\&quot;&gt;The fees incurred by the payment&lt;\\\/a&gt;&lt;\\\/li&gt;\\n&lt;li&gt;&lt;a href=\\&quot;\\\/pt\\\/platforms\\\/top-up-balance-account\\\/on-demand-top-ups\\&quot;&gt;The amount paid by your user to top up their balance account&lt;\\\/a&gt;&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;payments_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Refunds&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;For refunds, you can provide split instructions for booking:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;The sale amount of the refund&lt;\\\/li&gt;\\n&lt;li&gt;Your platform&#039;s commission that is now refunded&lt;\\\/li&gt;\\n&lt;li&gt;&lt;a href=\\&quot;\\\/pt\\\/platforms\\\/in-person-payments\\\/transaction-fees\\&quot;&gt;The fees incurred by the refund&lt;\\\/a&gt;&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;refunds_1_2&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Chargebacks&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;For &lt;a href=\\&quot;\\\/pt\\\/platforms\\\/online-payments\\\/split-transactions\\\/split-chargebacks\\\/\\&quot; target=\\&quot;_blank\\&quot;&gt;chargebacks&lt;\\\/a&gt;, you can provide split instructions for booking:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;The disputed amount of the chargeback&lt;\\\/li&gt;\\n&lt;li&gt;The fees incurred by the chargeback&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;chargebacks_2_3&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>Send split instructions<\/h2>\n<p>When you send an API request for a payment or refund, you must define split instructions for each <a href=\"#split-types\">type of split<\/a> of the full transaction amount.<\/p>\n<p>To define split instructions in your Terminal API payment or referenced refund requests:<\/p>\n<ol>\n<li>Format the split instructions either as a string of form-encoded key-value pairs, or as a JSON object converted to a Base64-encoded string.<\/li>\n<li>Pass the formatted string of split instructions in the <code>SaleToAcquirerData<\/code> parameter of your <a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization\">payment authorization<\/a> or <a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-refunds\">refund<\/a> request.<\/li>\n<\/ol>\n<p>To define split instructions in your Checkout API  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/(paymentPspReference)\/captures\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments\/{paymentPspReference}\/captures<\/a> requests:<\/p>\n<ol>\n<li>Get the PSP reference of the payment authorization you want to capture.<\/li>\n<li>Pass the split instructions in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/(paymentPspReference)\/captures#request-splits\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">splits<\/a> array of your <a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-capture\">capture request<\/a>.<\/li>\n<\/ol>\n<p>For more information on making a payment, capture, or refund request with splits, see the following pages:<\/p>\n<ul>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization\">Split a payment at authorization<\/a><\/li>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-payments-at-capture\">Split a payment at capture<\/a><\/li>\n<li><a href=\"\/pt\/platforms\/in-person-payments\/split-transactions\/split-refunds\">Split refunds<\/a><\/li>\n<\/ul>\n<h2>Split types<\/h2>\n<p>When you send an API request for a transaction, you must define split instructions for each split of the full transaction amount using the <code>SaleToAcquirerData<\/code> parameter. In each set of split instructions within the <code>SaleToAcquirerData<\/code>, you must use the <code>type<\/code> field to define the purpose of that split.<\/p>\n<p>Certain split types also require you to define other values in the split instructions. For example, when you want to book the split amount to your user's balance account (<code>type<\/code> is <strong>BalanceAccount<\/strong>), you must specify the ID of that balance account using the <code>account<\/code> parameter.<\/p>\n<p>The following table shows the possible split <code>type<\/code> values you can send in your request, and whether you must send another parameter (<code>account<\/code>, <code>amount<\/code>, or <code>reference<\/code>) in the split instruction. If you do not specify an <code>account<\/code> in your split instructions, the split amount is booked to your liable balance account.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Split type<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<th style=\"text-align: left;\">Required additional parameters<\/th>\n<th style=\"text-align: left;\">Recommended additional parameters<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>BalanceAccount<\/strong><\/td>\n<td style=\"text-align: left;\">Books a part of the transaction to your user's balance account. You must specify the <code>account<\/code> and the <code>amount<\/code> in your request.<\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>amount<\/code><br><br><code>reference<\/code><\/td>\n<td style=\"text-align: left;\"><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Commission<\/strong><\/td>\n<td style=\"text-align: left;\">Books your platform's commission to your liable balance account.<\/td>\n<td style=\"text-align: left;\"><code>amount<\/code><\/td>\n<td style=\"text-align: left;\"><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Interchange<\/strong><\/td>\n<td style=\"text-align: left;\">Books the fee paid to the issuer to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>SchemeFee<\/strong><\/td>\n<td style=\"text-align: left;\">Books the scheme fee to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>AcquiringFees<\/strong><\/td>\n<td style=\"text-align: left;\">Books the aggregated amount of the interchange and scheme fees to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>AdyenCommission<\/strong><\/td>\n<td style=\"text-align: left;\">Books the transaction fee due to Adyen under <a href=\"https:\/\/www.adyen.com\/knowledge-hub\/interchange-fees-explained\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">blended rates<\/a> to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>AdyenMarkup<\/strong><\/td>\n<td style=\"text-align: left;\">Books the transaction fee due to Adyen under <a href=\"https:\/\/www.adyen.com\/knowledge-hub\/interchange-fees-explained\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Interchange ++ pricing<\/a> to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>AdyenFees<\/strong><\/td>\n<td style=\"text-align: left;\">Books the aggregated amount of Adyen's commission and markup to the specified balance account.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>PaymentFee<\/strong><\/td>\n<td style=\"text-align: left;\">Books the aggregated amount of all the <a href=\"\/pt\/platforms\/in-person-payments\/transaction-fees\">transaction fees<\/a> to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>VAT<\/strong><\/td>\n<td style=\"text-align: left;\">Books the value-added tax (VAT) incurred on a payment to the specified <code>account<\/code>, allowing you to book this tax separately from the sale amount.<\/td>\n<td style=\"text-align: left;\"><code>amount<\/code><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Surcharge<\/strong><\/td>\n<td style=\"text-align: left;\">Books the <a href=\"\/pt\/platforms\/in-person-payments\/surcharge\">surcharge<\/a> paid by the customer to the specified <code>account<\/code>.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Tip<\/strong><\/td>\n<td style=\"text-align: left;\">Books the <a href=\"\/pt\/platforms\/in-person-payments\/tipping\">tip (gratuity)<\/a> paid by the customer to the specified <code>account<\/code>. The tip amount is provided by the customer on the terminal.<\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\"><code>account<\/code><br><br><code>reference<\/code><\/td>\n<td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments\/split-transactions","articleFields":{"description":"Learn how to split transactions in your platform.","feedback_component":true,"next_steps":[{"title":"Split payments at authorization","description":"Learn how to split a payment at the time of authorization.","url":"\/platforms\/in-person-payments\/split-transactions\/split-payments-at-authorization","required":false},{"title":"Split payments at capture","description":"Learn how to split a payment at the time of capture.","url":"\/platforms\/in-person-payments\/split-transactions\/split-payments-at-capture","required":false},{"title":"Split refunds","description":"Learn how to split refunds","url":"\/platforms\/in-person-payments\/split-transactions\/split-refunds","required":false}],"id":"25142904","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"23-04-2024 16:12","filters_component":false,"parameters":{"directoryPath":"\/platforms","model":"platform","channel":"pos"},"decision_tree":"[]","page_id":"f2e6485d-9f68-4ada-847e-0bec3c03dabc"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/platforms\/in-person-payments\/split-transactions","title":"Split transactions between balance accounts","content":"To make sure that the pay-in, settlement, and payout processes run smoothly for all users' transactions, you must book the funds and fees to the correct balance accounts.\nThis means that you must define instructions about how to split the funds between your user's balance accounts and your platform's liable balance account. You can define these instructions in the following ways:\n\nAutomatically split all transactions processed through your user's store by setting up split configuration profiles.\nSplit transactions by defining instructions for each API request. The instructions you provide in your API requests override the instructions you defined in your split configuration profiles.\n\nIf you do not provide any split instructions in a split configuration profile or through an API request, the whole transaction amount and fees are booked to your liable balance account.\nRequirements\nIn addition to the general requirements for in-person payments with an Adyen for Platforms integration, take into account the following requirement.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA Terminal API integration with payment terminals or with a Mobile solution. The standalone solution does not support adding split instructions to individual payments or refunds\n\n\n\nSplit specific transactions\nIf you want to define separate instructions for specific transactions in your platform, you can define the split instructions in your API requests. The instructions you provide in your API requests override any automatic split configuration profiles applied to your user's store.\nThe following information on this page explains the process of defining split instructions for specific transactions. Before sending an API request with split instructions, make sure you understand:\n\nWhen to provide split instructions\nHow you can split a transaction\nHow to send split instructions\nWhich split types you can include in your request\n\nWhen to provide split instructions\nYou can provide instructions to split payments when you make the following requests:\n\nA Terminal API payment request to authorize a payment.\nA Checkout API \/captures request to capture a payment.\n\nYou can provide instructions to split refunds when you make the following request:\n\nA Terminal API referenced refund request\n\nThis means that for every individual authorization, capture, or refund request that occurs in your platform, you can determine how to book the funds from that transaction.\nHow to split a transaction\nWhen you process transactions for your users, you can split the funds and book them to any number of balance accounts in your platform.\n\n\n    \n        \n        \n    \n\n\nSend split instructions\nWhen you send an API request for a payment or refund, you must define split instructions for each type of split of the full transaction amount.\nTo define split instructions in your Terminal API payment or referenced refund requests:\n\nFormat the split instructions either as a string of form-encoded key-value pairs, or as a JSON object converted to a Base64-encoded string.\nPass the formatted string of split instructions in the SaleToAcquirerData parameter of your payment authorization or refund request.\n\nTo define split instructions in your Checkout API  \/payments\/{paymentPspReference}\/captures requests:\n\nGet the PSP reference of the payment authorization you want to capture.\nPass the split instructions in the  splits array of your capture request.\n\nFor more information on making a payment, capture, or refund request with splits, see the following pages:\n\nSplit a payment at authorization\nSplit a payment at capture\nSplit refunds\n\nSplit types\nWhen you send an API request for a transaction, you must define split instructions for each split of the full transaction amount using the SaleToAcquirerData parameter. In each set of split instructions within the SaleToAcquirerData, you must use the type field to define the purpose of that split.\nCertain split types also require you to define other values in the split instructions. For example, when you want to book the split amount to your user's balance account (type is BalanceAccount), you must specify the ID of that balance account using the account parameter.\nThe following table shows the possible split type values you can send in your request, and whether you must send another parameter (account, amount, or reference) in the split instruction. If you do not specify an account in your split instructions, the split amount is booked to your liable balance account.\n\n\n\nSplit type\nDescription\nRequired additional parameters\nRecommended additional parameters\n\n\n\n\nBalanceAccount\nBooks a part of the transaction to your user's balance account. You must specify the account and the amount in your request.\naccountamountreference\n\n\n\nCommission\nBooks your platform's commission to your liable balance account.\namount\nreference\n\n\nInterchange\nBooks the fee paid to the issuer to the specified account.\n\naccountreference\n\n\nSchemeFee\nBooks the scheme fee to the specified account.\n\naccountreference\n\n\nAcquiringFees\nBooks the aggregated amount of the interchange and scheme fees to the specified account.\n\naccountreference\n\n\nAdyenCommission\nBooks the transaction fee due to Adyen under blended rates to the specified account.\n\naccountreference\n\n\nAdyenMarkup\nBooks the transaction fee due to Adyen under Interchange ++ pricing to the specified account.\n\naccountreference\n\n\nAdyenFees\nBooks the aggregated amount of Adyen's commission and markup to the specified balance account.\n\naccountreference\n\n\nPaymentFee\nBooks the aggregated amount of all the transaction fees to the specified account.\n\naccountreference\n\n\nVAT\nBooks the value-added tax (VAT) incurred on a payment to the specified account, allowing you to book this tax separately from the sale amount.\namount\naccountreference\n\n\n\nSurcharge\nBooks the surcharge paid by the customer to the specified account.\n\naccountreference\n\n\n\nTip\nBooks the tip (gratuity) paid by the customer to the specified account. The tip amount is provided by the customer on the terminal.\n\naccountreference\n\n\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Platforms","lvl2":"Process in-person payments","lvl3":"Split transactions between balance accounts"},"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":"\/pt\/platforms\/in-person-payments\/split-transactions"},"levels":4,"category":"Platforms","category_color":"green","tags":["Split","transactions","between","balance","accounts"]}}
