{"title":"SaleToAcquirerData","category":"default","creationDate":1776961627,"content":"<p>The examples on this page illustrate the structure of many of the data elements that you can pass in the <code>SaleToAcquirerData<\/code> field of your Terminal API payment request.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements.<\/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\/basic-tapi-integration\/\">Terminal API<\/a> integration with payment terminals or with a <a href=\"\/pt\/point-of-sale\/ipp-mobile\">Mobile solution<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin, <a href=\"\/pt\/point-of-sale\/add-data#receive-additional-data\">select the data you want to receive in the additional response<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>SaleToAcquirerData sample collection<\/h2>\n<p>Be aware that the list of <code>additionalData<\/code> elements is long and growing, so we cannot mention all of them here. See for example the <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/Payment\/latest\/authorise__reqParam_additionalData\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Additional data in our API Explorer<\/a>. Many of these elements also apply to point-of-sale payments.<\/p>\n\n<div id=\"tabXF17y\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;JSON object&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;For instructions, see &lt;a href=\\&quot;\\\/pt\\\/point-of-sale\\\/add-data#base64-json\\&quot;&gt;Option 1: Pass data elements as Base-64 encoded JSON&lt;\\\/a&gt;.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;&#039;\\&quot; :id=\\&quot;&#039;json-sale-to-acquirer&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;applicationInfo\\\\\\&quot;: {\\\\n        \\\\\\&quot;externalPlatform\\\\\\&quot;: {\\\\n            \\\\\\&quot;name\\\\\\&quot;: \\\\\\&quot;COMPANY_NAME_OR_PLATFORM_NAME\\\\\\&quot;,\\\\n            \\\\\\&quot;version\\\\\\&quot;: \\\\\\&quot;1.3\\\\\\&quot;,\\\\n            \\\\\\&quot;integrator\\\\\\&quot;: \\\\\\&quot;COMPANY_THAT_BUILT_INTEGRATION_OR_POS_APP\\\\\\&quot;\\\\n        },\\\\n        \\\\\\&quot;merchantApplication\\\\\\&quot;: {\\\\n            \\\\\\&quot;name\\\\\\&quot;: \\\\\\&quot;NAME_OF_POS_APPLICATION\\\\\\&quot;,\\\\n            \\\\\\&quot;version\\\\\\&quot;: \\\\\\&quot;2.13.05\\\\\\&quot;\\\\n        },\\\\n        \\\\\\&quot;merchantDevice\\\\\\&quot;: {\\\\n            \\\\\\&quot;os\\\\\\&quot;: \\\\\\&quot;OS_OF_DEVICE_THAT_RUNS_POS_APPLICATION\\\\\\&quot;,\\\\n            \\\\\\&quot;osVersion\\\\\\&quot;: \\\\\\&quot;16.3\\\\\\&quot;\\\\n        }\\\\n    },\\\\n    \\\\\\&quot;metadata\\\\\\&quot;: {\\\\n        \\\\\\&quot;someMetaDataKey1\\\\\\&quot;: \\\\\\&quot;YOUR_VALUE\\\\\\&quot;,\\\\n        \\\\\\&quot;someMetaDataKey2\\\\\\&quot;: \\\\\\&quot;YOUR_VALUE\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;recurringProcessingModel\\\\\\&quot;: \\\\\\&quot;Subscription\\\\\\&quot;,\\\\n    \\\\\\&quot;recurringDetailName\\\\\\&quot;: \\\\\\&quot;YOUR_VALUE\\\\\\&quot;,\\\\n    \\\\\\&quot;recurringTokenService\\\\\\&quot;: \\\\\\&quot;YOUR_VALUE\\\\\\&quot;,\\\\n    \\\\\\&quot;shopperEmail\\\\\\&quot;: \\\\\\&quot;S.Hopper@example.com\\\\\\&quot;,\\\\n    \\\\\\&quot;shopperReference\\\\\\&quot;: \\\\\\&quot;YOUR_UNIQUE_SHOPPER_ID\\\\\\&quot;,\\\\n    \\\\\\&quot;shopperStatement\\\\\\&quot;: \\\\\\&quot;YOUR_PAYMENT_DESCRIPTION\\\\\\&quot;,\\\\n    \\\\\\&quot;store\\\\\\&quot;: \\\\\\&quot;YOUR_STORE_REFERENCE\\\\\\&quot;,\\\\n    \\\\\\&quot;tenderOption\\\\\\&quot;: \\\\\\&quot;ReceiptHandler,AskGratuity\\\\\\&quot;,\\\\n    \\\\\\&quot;additionalData\\\\\\&quot;: {\\\\n        \\\\\\&quot;authorisationType\\\\\\&quot;: \\\\\\&quot;PreAuth\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.customerServiceTollFreeNumber\\\\\\&quot;: \\\\\\&quot;1800433999\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.checkInDate\\\\\\&quot;: \\\\\\&quot;20200219\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.checkOutDate\\\\\\&quot;: \\\\\\&quot;20200222\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.folioNumber\\\\\\&quot;: \\\\\\&quot;13579111315\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.propertyPhoneNumber\\\\\\&quot;: \\\\\\&quot;1800433999\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.room1.rate\\\\\\&quot;: \\\\\\&quot;15000\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.room1.tax\\\\\\&quot;: \\\\\\&quot;1000\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.room1.numberOfNights\\\\\\&quot;: \\\\\\&quot;3\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.fireSafetyActIndicator\\\\\\&quot;: \\\\\\&quot;Y\\\\\\&quot;,\\\\n        \\\\\\&quot;lodging.totalRoomTax\\\\\\&quot;: \\\\\\&quot;2000\\\\\\&quot;,\\\\n        \\\\\\&quot;split.api\\\\\\&quot;: \\\\\\&quot;1\\\\\\&quot;,\\\\n        \\\\\\&quot;split.nrOfItems\\\\\\&quot;: \\\\\\&quot;2\\\\\\&quot;,\\\\n        \\\\\\&quot;split.totalAmount\\\\\\&quot;: \\\\\\&quot;62000\\\\\\&quot;,\\\\n        \\\\\\&quot;split.currencyCode\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&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;TestPayment\\\\\\&quot;,\\\\n        \\\\\\&quot;split.item1.description\\\\\\&quot;: \\\\\\&quot;TestDescription\\\\\\&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;TestCommission\\\\\\&quot;,\\\\n        \\\\\\&quot;surchargeFee\\\\\\&quot;: \\\\\\&quot;VALUE_IN_MINOR_UNITS\\\\\\&quot;,\\\\n        \\\\\\&quot;taxfree.indicator\\\\\\&quot;: false,\\\\n        \\\\\\&quot;travelEntertainmentAuthData.market\\\\\\&quot;: \\\\\\&quot;H\\\\\\&quot;,\\\\n        \\\\\\&quot;travelEntertainmentAuthData.duration\\\\\\&quot;: \\\\\\&quot;3\\\\\\&quot;,\\\\n        \\\\\\&quot;manualCapture\\\\\\&quot;: \\\\\\&quot;false\\\\\\&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&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;json_object_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Key-value pairs&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;For instructions, see &lt;a href=\\&quot;\\\/pt\\\/point-of-sale\\\/add-data#key-value-pairs\\&quot;&gt;Option 2: Pass data elements as key-value pairs&lt;\\\/a&gt;.&lt;\\\/p&gt;\\n&lt;pre&gt;&lt;code class=\\&quot;language-raw\\&quot;&gt;applicationInfo.externalPlatform.name=COMPANY_NAME_OR_PLATFORM_NAME\\napplicationInfo.externalPlatform.version=1.3\\napplicationInfo.externalPlatform.integrator=COMPANY_THAT_BUILT_INTEGRATION_OR_POS_APP\\napplicationInfo.merchantApplication.name=NAME_OF_POS_APPLICATION\\napplicationInfo.merchantApplication.version=2.13.05\\napplicationInfo.merchantDevice.os=OS_OF_DEVICE_THAT_RUNS_POS_APPLICATION\\napplicationInfo.merchantDevice.osVersion=16.3\\nmetadata.someMetaDataKey1=YOUR_VALUE\\nmetadata.someMetaDataKey2=YOUR_VALUE\\nrecurringProcessingModel=Subscription\\nrecurringDetailName=YOUR_VALUE\\nrecurringTokenService=YOUR_VALUE\\nshopperEmail=S.Hopper@example.com\\nshopperReference=YOUR_UNIQUE_SHOPPER_ID\\nshopperStatement=YOUR_PAYMENT_DESCRIPTION\\nstore=YOUR_STORE_REFERENCE\\ntaxfree.indicator=false\\ntenderOption=ReceiptHandler,AskGratuity\\nsplit.api=1\\nsplit.nrOfItems=2\\nsplit.totalAmount=62000\\nsplit.currencyCode=EUR\\nsplit.item1.amount=60000\\nsplit.item1.type=BalanceAccount\\nsplit.item1.account=BA00000000000000000000001\\nsplit.item1.reference=TestPayment\\nsplit.item1.description=TestDescription\\nsplit.item2.amount=2000\\nsplit.item2.type=Commission\\nsplit.item2.reference=TestCommission\\nadditionalData.authorisationType=PreAuth\\nadditionalData.lodging.customerServiceTollFreeNumber=1800433999\\nadditionalData.lodging.checkInDate=20200219\\nadditionalData.lodging.checkOutDate=20200222\\nadditionalData.lodging.folioNumber=13579111315\\nadditionalData.lodging.propertyPhoneNumber=1800433999\\nadditionalData.lodging.room1.rate=15000\\nadditionalData.lodging.room1.tax=1000\\nadditionalData.lodging.room1.numberOfNights=3\\nadditionalData.lodging.fireSafetyActIndicator=Y\\nadditionalData.lodging.totalRoomTax=2000\\nadditionalData.travelEntertainmentAuthData.market=H\\nadditionalData.travelEntertainmentAuthData.duration=3\\nadditionalData.manualCapture=false&lt;\\\/code&gt;&lt;\\\/pre&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;key-value_pairs_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/point-of-sale\/add-data\"\n                        target=\"_self\"\n                        >\n                    Add information to a payment\n                <\/a><\/li><li><a href=\"\/point-of-sale\/add-data\/tender-options\"\n                        target=\"_self\"\n                        >\n                    Pass tender options\n                <\/a><\/li><li><a href=\"https:\/\/docs.adyen.com\/api-explorer\/Payment\/latest\/overview\"\n                        target=\"_blank\"\n                         class=\"external\">\n                    Additional data in our API Explorer\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/add-data\/sale-to-acquirer-data","articleFields":{"page_id":"6963c0aa-0b4a-4251-8da2-d7d5a78573fa","feedback_component":true,"filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/add-data\/sale-to-acquirer-data","title":"SaleToAcquirerData","content":"The examples on this page illustrate the structure of many of the data elements that you can pass in the SaleToAcquirerData field of your Terminal API payment request.\nRequirements\nBefore you begin, take into account the following requirements.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA Terminal API integration with payment terminals or with a Mobile solution.\n\n\nSetup steps\nBefore you begin, select the data you want to receive in the additional response.\n\n\n\nSaleToAcquirerData sample collection\nBe aware that the list of additionalData elements is long and growing, so we cannot mention all of them here. See for example the Additional data in our API Explorer. Many of these elements also apply to point-of-sale payments.\n\n\n    \n        \n        \n    \n\n\nSee also\n\n\n                    Add information to a payment\n                \n                    Pass tender options\n                \n                    Additional data in our API Explorer\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Adicionar informa\u00e7\u00f5es a um pagamento","lvl3":"SaleToAcquirerData"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/add-data","lvl3":"\/pt\/point-of-sale\/add-data\/sale-to-acquirer-data"},"levels":4,"category":"In-person payments","category_color":"green","tags":["SaleToAcquirerData"]},"articleFiles":{"json-sale-to-acquirer.json":"<p alt=\"\">json-sale-to-acquirer.json<\/p>"}}
