{"title":"Handle the Additional Data callback","category":"default","creationDate":1776961627,"content":"

Handle the callback<\/h2>\n

The TenderAdditionalData<\/code> callback is tender-based and includes both a PED object and tender object as parameters.\u00a0<\/p>\n

Parameters<\/h3>\n\n\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
pedObj<\/code><\/td>\nPedDevice<\/a><\/td>\nPED object that represents the terminal.<\/td>\n<\/tr>\n
tenderObj<\/code><\/td>\nTender<\/a><\/td>\nThe tender associated with the additional data.<\/td>\n<\/tr>\n
headerObj<\/code><\/td>\nResponseHdr<\/td>\nHeader object that includes generic statuses, information about merchant, additional data from the PED.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Confirm the additional data to the Adyen payments platform<\/h2>\n

Use ConfirmAdditionalData<\/code> to provide additional data to the terminal. After the POS receives the additional data callback from the PED, the POS must confirm this in order to continue the transaction. At this point, based upon the information received during the callback, the amount can be adjusted. The currency must be the same as the original currency.<\/p>\n

Parameters<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
adjustedAmountValue<\/code><\/td>\nlong<\/td>\n\"-white_check_mark-\"<\/td>\nFinal (potentially adjusted) value of the transaction.<\/td>\n<\/tr>\n
amountCurrency<\/code><\/td>\nString<\/td>\n\"-white_check_mark-\"<\/td>\nCurrency of the amount.<\/td>\n<\/tr>\n
shopperReference<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nUse this field to record the shopper reference with the transaction and for recurring or one-click functionality shopper data.<\/td>\n<\/tr>\n
shopperEmail<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nSupply a shopper reference and\/or shopper email to allow for digital shopper recognition.<\/td>\n<\/tr>\n
recurring_contract<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nRecurring contract reference. Use this field to\u00a0set up\u00a0recurring or one-click functionality.<\/td>\n<\/tr>\n
recurring_contract_detail_name<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nRecurring contract details. Use this field to\u00a0set up\u00a0recurring or one-click functionality.<\/td>\n<\/tr>\n
additionalData<\/code><\/td>\nAdditionalData<\/a><\/td>\n\"-x-\"<\/td>\nAdditional data returned by Adyen.\u00a0The\u00a0additionalData<\/code>\u00a0object is a generic container that can hold extra response fields.<\/td>\n<\/tr>\n
transactionType<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nType of transaction, for example: GOODSSERVICES, REFUND.\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

A new, possibly altered, amount must be provided, typically used to offer a loyalty discount.<\/p>\n

Getter<\/h2>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
GetValueByKey<\/code><\/td>\nReturn a value from an array by using a key.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Parameters<\/h3>\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
key<\/code><\/td>\nString<\/td>\n\"-white_check_mark-\"<\/td>\nKey used to retrieve value from the array.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Additional data elements<\/h2>\n

When something triggers the additional data callback, the callback provides the cash register with a large number of data elements that can be used 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.<\/p>\n

An example list contains the following:<\/p>\n<\/colgroup>
additionalDataKey<\/th>additionalDataValue<\/th><\/tr><\/thead>
alias<\/td>M469509594859802<\/td><\/tr>
cardIssueNumber<\/td>53<\/td><\/tr>
tid<\/td>83814241<\/td><\/tr>
posOriginalAmountValue<\/td>14823<\/td><\/tr>
cardHolderName<\/td>TC02_MC_Approved<\/td><\/tr>
merchantReference<\/td>Mref-12345<\/td><\/tr>
transactionType<\/td>GOODS_SERVICES<\/td><\/tr>
cardIssuerCountryId<\/td>056<\/td><\/tr>
cardSummary<\/td>9999<\/td><\/tr>
cardBin<\/td>541333<\/td><\/tr>
paymentMethod<\/td>mc<\/td><\/tr>
paymentMethodVariant<\/td>mccredit<\/td><\/tr>
applicationLabel<\/td>MCNL<\/td><\/tr>
posAuthAmountValue<\/td>14823<\/td><\/tr>
posAuthAmountCurrency<\/td>EUR<\/td><\/tr>
txdate<\/td>1-4-2018<\/td><\/tr>
txtime<\/td>09:34:34<\/td><\/tr>
iso8601TxDate<\/td>2018-04-01T09:34:34.0000000+0000<\/td><\/tr>
applicationPreferredName<\/td>mc nl<\/td><\/tr>
AID<\/td>A000000004101001<\/td><\/tr>
posEntryMode<\/td>ICC<\/td><\/tr>
expiryMonth<\/td>02<\/td><\/tr>
expiryYear<\/td>2028<\/td><\/tr><\/tbody><\/table>\n

You can provide the following optional additional elements:<\/p>\n\n\n\n\n\n\n
<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
shopperReference<\/td>\nshopref123456789<\/td>\n<\/tr>\n
shopperEmail<\/td>\nmy.name@email.com<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

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, for example Gratuity<\/strong><\/span> .<\/p>\n<\/div><\/div>","url":"https:\/\/docs.adyen.com\/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","articleFields":{"id":"25143518","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\/key-steps-com-extension\/process-a-basic-transaction-com-extension\/handle-the-additional-data-callback-com-extension","title":"Handle the Additional Data callback","content":"Handle the callback\nThe TenderAdditionalData callback is tender-based and includes both a PED object and tender object as parameters.\u00a0\nParameters\n\n\n\nName\nType\nDescription\n\n\n\n\npedObj\nPedDevice\nPED object that represents the terminal.\n\n\ntenderObj\nTender\nThe tender associated with the additional data.\n\n\nheaderObj\nResponseHdr\nHeader object that includes generic statuses, information about merchant, additional data from the PED.\n\n\n\nConfirm the additional data to the Adyen payments platform\nUse ConfirmAdditionalData to provide additional data to the terminal. After the POS receives the additional data callback from the PED, the POS must confirm this in order to continue the transaction. At this point, based upon the information received during the callback, the amount can be adjusted. The currency must be the same as the original currency.\nParameters\n\n\n\nName\nType\nRequired\nDescription\n\n\n\n\nadjustedAmountValue\nlong\n\nFinal (potentially adjusted) value of the transaction.\n\n\namountCurrency\nString\n\nCurrency of the amount.\n\n\nshopperReference\nString\n\nUse this field to record the shopper reference with the transaction and for recurring or one-click functionality shopper data.\n\n\nshopperEmail\nString\n\nSupply a shopper reference and\/or shopper email to allow for digital shopper recognition.\n\n\nrecurring_contract\nString\n\nRecurring contract reference. Use this field to\u00a0set up\u00a0recurring or one-click functionality.\n\n\nrecurring_contract_detail_name\nString\n\nRecurring contract details. Use this field to\u00a0set up\u00a0recurring or one-click functionality.\n\n\nadditionalData\nAdditionalData\n\nAdditional data returned by Adyen.\u00a0The\u00a0additionalData\u00a0object is a generic container that can hold extra response fields.\n\n\ntransactionType\nString\n\nType of transaction, for example: GOODSSERVICES, REFUND.\u00a0\n\n\n\nA new, possibly altered, amount must be provided, typically used to offer a loyalty discount.\nGetter\n\n\n\nName\nDescription\n\n\n\n\nGetValueByKey\nReturn a value from an array by using a key.\n\n\n\nParameters\n\n\n\nName\nType\nRequired\nDescription\n\n\n\n\nkey\nString\n\nKey used to retrieve value from the array.\n\n\n\nAdditional data elements\nWhen something triggers the additional data callback, the callback provides the cash register with a large number of data elements that can be used 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.\nAn example list contains the following:\nadditionalDataKeyadditionalDataValuealiasM469509594859802cardIssueNumber53tid83814241posOriginalAmountValue14823cardHolderNameTC02_MC_ApprovedmerchantReferenceMref-12345transactionTypeGOODS_SERVICEScardIssuerCountryId056cardSummary9999cardBin541333paymentMethodmcpaymentMethodVariantmccreditapplicationLabelMCNLposAuthAmountValue14823posAuthAmountCurrencyEURtxdate1-4-2018txtime09:34:34iso8601TxDate2018-04-01T09:34:34.0000000+0000applicationPreferredNamemc nlAIDA000000004101001posEntryModeICCexpiryMonth02expiryYear2028\nYou can provide the following optional additional elements:\n\n\n\n\n\n\n\n\n\nshopperReference\nshopref123456789\n\n\nshopperEmail\nmy.name@email.com\n\n\n\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, for example Gratuity .\n","type":"page","locale":"pt","boost":13,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"Key steps","lvl6":"Process a basic transaction","lvl7":"Handle the Additional Data callback"},"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\/key-steps-com-extension","lvl6":"https:\/\/docs.adyen.com\/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","lvl7":"\/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"},"levels":8,"category":"In-person payments","category_color":"green","tags":["Handle","Additional","callback"]}}