No momento, esta página não está disponível em português
Point-of-sale icon

AdditionalData

Name Description
AdditionalData Additional data you pass with the tender. The additionalData object 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.

Additional data elements

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:

additionalDataKeyadditionalDataValue
aliasM469509594859802
cardIssueNumber53
tid83814241
posOriginalAmountValue14823
cardHolderNameTC02_MC_Approved
merchantReferenceMref-12345
transactionTypeGOODS_SERVICES
cardIssuerCountryId056
cardSummary9999
cardBin541333
paymentMethodmc
paymentMethodVariantmccredit
applicationLabelMCNL
posAuthAmountValue14823
posAuthAmountCurrencyEUR
txdate1-4-2018
txtime09:34:34
iso8601TxDate

2018-04-01T09:34:34.0000000+0000

This field returns time in GMT format.

applicationPreferredNamemc nl
AIDA000000004101001
posEntryModeICC
expiryMonth02
expiryYear2028
Optionally additional elements can be provided:
shopperReferenceYOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
shopperEmailmy.name@email.com
stored_value_redemption_typePerform a cash back or deactivate a card by passing a stored value redemption type in additional data. 
  • cashback - 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.

  • deactivate (not available for SVS) - Deactivates a gift card.  (Deactivate is not available for SVS).

  • gratuity (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".

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.

Use this object in the following calls and callbacks to represent the Additional Data: