{"title":"Split data in additionalData","category":"Classic Platforms","creationDate":1776961628,"content":"<div class=\"sc-notice note\"><div>\n<p>This page describes providing split instructions in <code>additionalData<\/code>. This has been replaced with providing <a href=\"\/pt\/classic-platforms\/processing-payments\">split instructions as a root element<\/a> starting with API version 37.<\/p>\n<p>For information about platform integrations built after August 1, 2022, refer to our <a href=\"\/pt\/adyen-for-platforms-model\">new integration guide<\/a> instead.<\/p>\n<\/div><\/div>\n<p>Learn how to provide split instructions in the <code>additionalData<\/code> object.<\/p>\n<h2 id=\"providing-split-instructions\">Providing split instructions<\/h2>\n<p>Split instructions define how a payment is split. You can split the payment amount into any number of\u00a0<a href=\"\/pt\/classic-platforms\/account-structure\">accounts<\/a>.<\/p>\n<p>Provide split instructions in the\u00a0<code>additionalData<\/code>\u00a0object. This object is present in all payment requests for any payment integration (e.g.\u00a0<a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Payment\/authorise\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/authorise<\/a>\u00a0and\u00a0 <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a>\u00a0endpoints).<\/p>\n<div class=\"sc-notice info\"><div>\n<p>Split data can also be provided when submitting a <a href=\"\/pt\/online-payments\/capture\">capture<\/a> or <a href=\"\/pt\/online-payments\/refund\">refund<\/a> request.<\/p>\n<\/div><\/div>\n<p>Split API uses dot notation with key-value pairs to provide information.<\/p>\n<p>For each request, you will need to specify the\u00a0<code>split.api<\/code>\u00a0as\u00a0<strong>1<\/strong>, the amount of the transaction total in\u00a0<code>split.totalAmount<\/code>, and the currency in\u00a0<code>split.currencyCode<\/code>:<\/p>\n<pre><code class=\"language-json\">...\n\"additionalData\": {\n   \"split.api\":1,\n   \"split.totalAmount\":40000,\n   \"split.currencyCode\":\"USD\",\n   ...\n}<\/code><\/pre>\n<p>Provide the number of times you will split the payment in\u00a0<code>split.nrOfItems<\/code>. Specify each split as an\u00a0<code>item<\/code>\u00a0followed by an incrementing number starting at\u00a0<strong>1<\/strong>:\u00a0<code>split.item1<\/code>,\u00a0<code>split.item2<\/code>, and so on.<\/p>\n<p>Each split item will also need to include:<\/p>\n<ul>\n<li>The\u00a0<code>amount<\/code>\u00a0to be split.<\/li>\n<li>The\u00a0split type. A\u00a0<code>type<\/code>\u00a0of\u00a0<span translate=\"no\"><strong>MarketPlace<\/strong><\/span>\u00a0sends the amount to the\u00a0<code>account<\/code>\u00a0specified. A split type of\u00a0<span translate=\"no\"><strong>Commission<\/strong><\/span>\u00a0sends the split to your\u00a0<a href=\"\/pt\/classic-platforms\/account-structure\">liable account<\/a>.<\/li>\n<li>The\u00a0<code>account<\/code>\u00a0to send the split. This is the\u00a0<code>accountCode<\/code>\u00a0of one of your account holder's accounts or your own liable account.<\/li>\n<li>An optional\u00a0<code>reference<\/code>, this is returned in our reporting for that specific transaction split.<\/li>\n<\/ul>\n<div class=\"sc-notice note\"><div>\n<p>Transactions are split into accounts and not account holders.<\/p>\n<\/div><\/div>\n<p>Here is an example for splitting a USD&nbsp;400.00 transaction:<\/p>\n<ul>\n<li>300.00 is being split into an account with\u00a0<code>accountCode<\/code>\u00a0of\u00a0<strong>163298747<\/strong>.<\/li>\n<li>100.00 being split into the platform's liable account.<\/li>\n<\/ul>\n<pre><code class=\"language-json\">\u00a0{\n   ...\n   \"additionalData\":{\n      \"split.api\":\"1\",\n      \"split.nrOfItems\":\"2\",\n      \"split.totalAmount\":40000,\n      \"split.currencyCode\":\"USD\",\n      \"split.item1.amount\":30000,\n      \"split.item1.type\":\"MarketPlace\",\n      \"split.item1.account\":\"163298747\",\n      \"split.item1.reference\":\"QXhlbFN0b2x0ZW5iZXJnCg\",\n      \"split.item2.amount\":10000,\n      \"split.item2.type\":\"Commission\",\n      \"split.item2.reference\":\"THVjYXNCbGVkc29lCg\"\n   },\n   ...\n}<\/code><\/pre>\n<h2 id=\"split-payment-with-authorise\">Split payment with \/authorise<\/h2>\n<p>Here is an example of split instructions provided with\u00a0<a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Payment\/authorise\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/authorise<\/a>\u00a0call.<\/p>\n<pre><code class=\"language-bash\">{\n   \"card\":{\n      \"number\":\"4400 0000 0000 0008\",\n      \"cvc\":\"737\",\n      \"expiryMonth\":\"03\",\n      \"expiryYear\":\"2030\",\n      \"holderName\":\"John Smith\"\n   },\n   \"amount\":{\n      \"value\":40000,\n      \"currency\":\"USD\"\n   },\n   \"reference\":\"YOUR_REFERENCE_NUMBER\",\n   \"merchantAccount\":\"YOUR_MERCHANT_ACCOUNT\",\n   \"additionalData\":{\n      \"split.api\":\"1\",\n      \"split.nrOfItems\":\"2\",\n      \"split.totalAmount\":\"40000\",\n      \"split.currencyCode\":\"USD\",\n      \"split.item1.amount\":\"30000\",\n      \"split.item1.type\":\"MarketPlace\",\n      \"split.item1.account\":\"163298747\",\n      \"split.item1.reference\":\"QXhlbFN0b2x0ZW5iZXJnCg\",\n      \"split.item2.amount\":\"10000\",\n      \"split.item2.type\":\"Commission\",\n      \"split.item2.reference\":\"THVjYXNCbGVkc29lCg\"\n   }\n}<\/code><\/pre>","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/processing-payments\/split-data-in-additionaldata","articleFields":{"search_category":"Classic Platforms","id":"47489332","robots":"noindex,nofollow","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"30-04-2019 10:05","parameters":{"directoryPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/processing-payments\/split-data-in-additionaldata","title":"Split data in additionalData","content":"\nThis page describes providing split instructions in additionalData. This has been replaced with providing split instructions as a root element starting with API version 37.\nFor information about platform integrations built after August 1, 2022, refer to our new integration guide instead.\n\nLearn how to provide split instructions in the additionalData object.\nProviding split instructions\nSplit instructions define how a payment is split. You can split the payment amount into any number of\u00a0accounts.\nProvide split instructions in the\u00a0additionalData\u00a0object. This object is present in all payment requests for any payment integration (e.g.\u00a0\/authorise\u00a0and\u00a0 \/payments\u00a0endpoints).\n\nSplit data can also be provided when submitting a capture or refund request.\n\nSplit API uses dot notation with key-value pairs to provide information.\nFor each request, you will need to specify the\u00a0split.api\u00a0as\u00a01, the amount of the transaction total in\u00a0split.totalAmount, and the currency in\u00a0split.currencyCode:\n...\n\"additionalData\": {\n   \"split.api\":1,\n   \"split.totalAmount\":40000,\n   \"split.currencyCode\":\"USD\",\n   ...\n}\nProvide the number of times you will split the payment in\u00a0split.nrOfItems. Specify each split as an\u00a0item\u00a0followed by an incrementing number starting at\u00a01:\u00a0split.item1,\u00a0split.item2, and so on.\nEach split item will also need to include:\n\nThe\u00a0amount\u00a0to be split.\nThe\u00a0split type. A\u00a0type\u00a0of\u00a0MarketPlace\u00a0sends the amount to the\u00a0account\u00a0specified. A split type of\u00a0Commission\u00a0sends the split to your\u00a0liable account.\nThe\u00a0account\u00a0to send the split. This is the\u00a0accountCode\u00a0of one of your account holder's accounts or your own liable account.\nAn optional\u00a0reference, this is returned in our reporting for that specific transaction split.\n\n\nTransactions are split into accounts and not account holders.\n\nHere is an example for splitting a USD&nbsp;400.00 transaction:\n\n300.00 is being split into an account with\u00a0accountCode\u00a0of\u00a0163298747.\n100.00 being split into the platform's liable account.\n\n\u00a0{\n   ...\n   \"additionalData\":{\n      \"split.api\":\"1\",\n      \"split.nrOfItems\":\"2\",\n      \"split.totalAmount\":40000,\n      \"split.currencyCode\":\"USD\",\n      \"split.item1.amount\":30000,\n      \"split.item1.type\":\"MarketPlace\",\n      \"split.item1.account\":\"163298747\",\n      \"split.item1.reference\":\"QXhlbFN0b2x0ZW5iZXJnCg\",\n      \"split.item2.amount\":10000,\n      \"split.item2.type\":\"Commission\",\n      \"split.item2.reference\":\"THVjYXNCbGVkc29lCg\"\n   },\n   ...\n}\nSplit payment with \/authorise\nHere is an example of split instructions provided with\u00a0\/authorise\u00a0call.\n{\n   \"card\":{\n      \"number\":\"4400 0000 0000 0008\",\n      \"cvc\":\"737\",\n      \"expiryMonth\":\"03\",\n      \"expiryYear\":\"2030\",\n      \"holderName\":\"John Smith\"\n   },\n   \"amount\":{\n      \"value\":40000,\n      \"currency\":\"USD\"\n   },\n   \"reference\":\"YOUR_REFERENCE_NUMBER\",\n   \"merchantAccount\":\"YOUR_MERCHANT_ACCOUNT\",\n   \"additionalData\":{\n      \"split.api\":\"1\",\n      \"split.nrOfItems\":\"2\",\n      \"split.totalAmount\":\"40000\",\n      \"split.currencyCode\":\"USD\",\n      \"split.item1.amount\":\"30000\",\n      \"split.item1.type\":\"MarketPlace\",\n      \"split.item1.account\":\"163298747\",\n      \"split.item1.reference\":\"QXhlbFN0b2x0ZW5iZXJnCg\",\n      \"split.item2.amount\":\"10000\",\n      \"split.item2.type\":\"Commission\",\n      \"split.item2.reference\":\"THVjYXNCbGVkc29lCg\"\n   }\n}","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Processing online payments","lvl3":"Split data in additionalData"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/classic-platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/processing-payments","lvl3":"\/pt\/classic-platforms\/processing-payments\/split-data-in-additionaldata"},"levels":4,"category":"Classic Platforms","category_color":"green","tags":["Split","additionalData"]}}