{"title":"AdditionalData","category":"default","creationDate":1776961627,"content":"<table>\n<thead>\n<tr>\n<th>Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>AdditionalData<\/td>\n<td>Additional data you pass with the tender. The\u00a0<code>additionalData<\/code>\u00a0object is a generic container that can hold extra response fields. The system uses the card number as a key to collect relevant additional data, for example loyalty data or recurring contract information.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"additional-data-elements\">Additional data elements<\/h2>\n<p>When the additional data callback is triggered the cash register is provided with a large number of data elements which can be used in business processes to make decisions on the progress of the transaction. This is typically used for loyalty as the most distinguishing information concerns the cardholder-specific information. An example list contains the following:<\/p>\n<table><thead><tr class=\"header\"><th>additionalDataKey<\/th><th>additionalDataValue<\/th><\/tr><\/thead><tbody><tr><td>alias<\/td><td>M469509594859802<\/td><\/tr><tr><td>cardIssueNumber<\/td><td>53<\/td><\/tr><tr><td>tid<\/td><td>83814241<\/td><\/tr><tr><td>posOriginalAmountValue<\/td><td>14823<\/td><\/tr><tr><td>cardHolderName<\/td><td>TC02_MC_Approved<\/td><\/tr><tr><td>merchantReference<\/td><td>Mref-12345<\/td><\/tr><tr><td>transactionType<\/td><td>GOODS_SERVICES<\/td><\/tr><tr><td>cardIssuerCountryId<\/td><td>056<\/td><\/tr><tr><td>cardSummary<\/td><td>9999<\/td><\/tr><tr><td>cardBin<\/td><td>541333<\/td><\/tr><tr><td>paymentMethod<\/td><td>mc<\/td><\/tr><tr><td>paymentMethodVariant<\/td><td>mccredit<\/td><\/tr><tr><td>applicationLabel<\/td><td>MCNL<\/td><\/tr><tr><td>posAuthAmountValue<\/td><td>14823<\/td><\/tr><tr><td>posAuthAmountCurrency<\/td><td>EUR<\/td><\/tr><tr><td>txdate<\/td><td>1-4-2018<\/td><\/tr><tr><td>txtime<\/td><td>09:34:34<\/td><\/tr><tr><td>iso8601TxDate<\/td><td><p>2018-04-01T09:34:34.0000000+0000<\/p><div class=\"sc-notice note\"><div><p>This field returns time in GMT format.<\/p><\/div><\/div><\/td><\/tr><tr><td>applicationPreferredName<\/td><td>mc nl<\/td><\/tr><tr><td>AID<\/td><td>A000000004101001<\/td><\/tr><tr><td>posEntryMode<\/td><td>ICC<\/td><\/tr><tr><td>expiryMonth<\/td><td>02<\/td><\/tr><tr><td>expiryYear<\/td><td>2028<\/td><\/tr><tr><td>Optionally additional elements can be provided:<\/td><td><\/td><\/tr><tr><td>shopperReference<\/td><td>YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j<\/td><\/tr><tr><td>shopperEmail<\/td><td><a href=\"mailto:my.name@email.com\" class=\"mailto\">my.name@email.com<\/a><\/td><\/tr><tr><td>stored_value_redemption_type<\/td><td>Perform a cash back or deactivate a card by passing a stored value redemption type in additional data.\u00a0<ul><li><span translate=\"no\"><strong>cashback -\u00a0<\/strong><\/span>Cash out the value of a gift card. For SVS, you must create a zero-value transaction to cash out the entire balance of a card. You can not cash out a specific amount.<\/li><li><p><span translate=\"no\"><strong>deactivate\u00a0<\/strong><\/span>(not available for SVS) - Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).<\/p><\/li><li><p><span translate=\"no\"><strong>gratuity\u00a0<\/strong><\/span>(SVS cards only) - Used to provide a tip from a gift card. (For SVS cards only).<\/p><\/li><\/ul><p>The cashback and deactivate values can be piped to chain the tasks by passing \"<span translate=\"no\"><strong>cashback|deactivate<\/strong><\/span>\".<\/p><\/td><\/tr><\/tbody><\/table>\n<div class=\"sc-notice note\"><div>\n<p>All these elements are present for chip-based transactions while several are non-existent for MSR or NFC transactions. Non-existence should not block the cash register from standard operating. Additional elements may be present depending on the transaction options like Gratuity.<\/p>\n<\/div><\/div>\n<p>Use this object in the following calls and callbacks to represent the Additional Data:<\/p>\n<ul>\n<li><a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/create-the-tender-com-extension\">Create the tender - COM extension<\/a><\/li>\n<li><a href=\"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/handle-the-additional-data-callback-com-extension\">Handle the Additional Data callback - COM extension<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/com-extension-for-windows-objects\/additionaldata","articleFields":{"id":"25143536","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/com-extension-for-windows-objects\/additionaldata","title":"AdditionalData","content":"\n\n\nName\nDescription\n\n\n\n\nAdditionalData\nAdditional data you pass with the tender. The\u00a0additionalData\u00a0object is a generic container that can hold extra response fields. The system uses the card number as a key to collect relevant additional data, for example loyalty data or recurring contract information.\n\n\n\nAdditional data elements\nWhen the additional data callback is triggered the cash register is provided with a large number of data elements which can be used in business processes to make decisions on the progress of the transaction. This is typically used for loyalty as the most distinguishing information concerns the cardholder-specific information. An example list contains the following:\nadditionalDataKeyadditionalDataValuealiasM469509594859802cardIssueNumber53tid83814241posOriginalAmountValue14823cardHolderNameTC02_MC_ApprovedmerchantReferenceMref-12345transactionTypeGOODS_SERVICEScardIssuerCountryId056cardSummary9999cardBin541333paymentMethodmcpaymentMethodVariantmccreditapplicationLabelMCNLposAuthAmountValue14823posAuthAmountCurrencyEURtxdate1-4-2018txtime09:34:34iso8601TxDate2018-04-01T09:34:34.0000000+0000This field returns time in GMT format.applicationPreferredNamemc nlAIDA000000004101001posEntryModeICCexpiryMonth02expiryYear2028Optionally additional elements can be provided:shopperReferenceYOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2jshopperEmailmy.name@email.comstored_value_redemption_typePerform a cash back or deactivate a card by passing a stored value redemption type in additional data.\u00a0cashback -\u00a0Cash out the value of a gift card. For SVS, you must create a zero-value transaction to cash out the entire balance of a card. You can not cash out a specific amount.deactivate\u00a0(not available for SVS) - Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).gratuity\u00a0(SVS cards only) - Used to provide a tip from a gift card. (For SVS cards only).The cashback and deactivate values can be piped to chain the tasks by passing \"cashback|deactivate\".\n\nAll these elements are present for chip-based transactions while several are non-existent for MSR or NFC transactions. Non-existence should not block the cash register from standard operating. Additional elements may be present depending on the transaction options like Gratuity.\n\nUse this object in the following calls and callbacks to represent the Additional Data:\n\nCreate the tender - COM extension\nHandle the Additional Data callback - COM extension\n","type":"page","locale":"pt","boost":14,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"COM Extension for Windows - Objects","lvl6":"AdditionalData"},"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\/classic-library-deprecation","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations","lvl4":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/com-extension-for-windows-objects","lvl6":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/com-extension-for-windows-objects\/additionaldata"},"levels":7,"category":"In-person payments","category_color":"green","tags":["AdditionalData"]}}
