Handle the Additional Data callback

Handle the callback

The TenderAdditionalData callback is tender-based and includes both a PED object and tender object as parameters. 

Parameters

Name

Type

Description

pedObj

PedDevice

PED object that represents the terminal.

tenderObj

Tender

The tender associated with the additional data.

headerObj

ResponseHdr

Header object that includes generic statuses, information about merchant, additional data from the PED.

Confirm the additional data to the Adyen payments platform

Use 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.

Parameters

Name

Type

Required

Description

adjustedAmountValue

long

(tick)

Final (potentially adjusted) value of the transaction.

amountCurrency

String

(tick)

Currency of the amount.

shopperReference

String

(error)

Use this field to record the shopper reference with the transaction and for recurring or one-click functionality shopper data.

shopperEmail String (error) Supply a shopper reference and/or shopper email to allow for digital shopper recognition.
recurring_contract String (error) Recurring contract reference. Use this field to set up recurring or one-click functionality.
recurring_contract_detail_name String (error) Recurring contract details. Use this field to set up recurring or one-click functionality.
additionalData AdditionalData (error) Additional data returned by Adyen. The additionalData object is a generic container that can hold extra response fields.
transactionType String (error)

Type of transaction, for example: GOODSSERVICES, REFUND. 

A new, possibly altered, amount must be provided, typically used to offer a loyalty discount.

Getter

Name
Description
GetValueByKey Return a value from an array by using a key.

Parameters

Name
Type
Required
Description
key String (tick) Key used to retrieve value from the array.

Additional data elements

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.

An example list contains the following:

additionalDataKey additionalDataValue
alias M469509594859802
cardIssueNumber 53
tid 83814241
posOriginalAmountValue 14823
cardHolderName TC02_MC_Approved
merchantReference Mref-12345
transactionType GOODS_SERVICES
cardIssuerCountryId 056
cardSummary 9999
cardBin 541333
paymentMethod mc
paymentMethodVariant mccredit
applicationLabel MCNL
posAuthAmountValue 14823
posAuthAmountCurrency EUR
txdate 1-4-2018
txtime 09:34:34
iso8601TxDate 2018-04-01T09:34:34.0000000+0000
applicationPreferredName mc nl
AID A000000004101001
posEntryMode ICC
expiryMonth 02
expiryYear 2028
Optionally additional elements can be provided:
shopperReference shopref123456789
shopperEmail my.name@email.com

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.