{"title":"Start gift card transactions","category":"default","creationDate":1776961627,"content":"

Class<\/h2>\n<\/colgroup>
Name<\/th>Description<\/th><\/tr><\/thead>
\n

MerchantPed<\/code><\/p>\n<\/td>

\n

Extends\u00a0 AdyenPed<\/code>.\u00a0 Class used to implement all PIN entry device (PED) functionality.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Special tender parameter<\/h2>\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
specialTender<\/code><\/td>\nSpecialTender<\/td>\nHolds tender attributes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Use the SpecialTenderBuilder to create the SpecialTender object:<\/p>\n

private SpecialTender buildSpecialTender() {\n\n        SpecialTender specialTender = new SpecialTender(merchantAccount,\n\n                merchantReference,\n\n                \"balanceInquiry\",\n\n                \"goldsmithscard\",\n\n                currency,\n\n                amount);\n\n        return specialTender;\n\n    }\n\u00a0\nSpecialTender specialTender = buildSpecialTender();<\/code><\/pre>\n
Instantiate special tender options<\/h2>\n\n\n\n\n\n
Name<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
specialOptions<\/code><\/td>\nSpecialOptions<\/td>\nHolds tender attributes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Parameters<\/h3>\n<\/colgroup>
Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n
transactionType<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
Type of gift card transaction (Redeem, which uses a card balance to pay for an item, Load, which loads a balance to a card, and Balance Inquiry which returns the current balance of the card).\u00a0TransactionType<\/code>\u00a0takes the following values:
  • redeem<\/li>
  • load<\/li>
  • balanceInquiry<\/li><\/ul><\/p>\n<\/td><\/tr>
\n
paymentMethodType<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
The type of payment method, in this case gift cards. For example, Givex, SVS, EagleEye.\u00a0PaymentMethodType<\/code> takes the following values:
  • givex<\/li>
  • svs<\/li><\/ul><\/p>\n<\/td><\/tr>
\n
shopperReference<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-x-\"<\/p>\n<\/td>
\n
Shopper identification (used for omnichannel digital customer recognition; minimum length three characters).<\/p>\n<\/td><\/tr>
\n
shopperEmail<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-x-\"<\/p>\n<\/td>
\n
Shopper identification (used for omnichannel digital customer recognition).<\/p>\n<\/td><\/tr>
\n
merchantAccount<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
The transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).<\/p>\n<\/td><\/tr>
\n
merchantReference<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
The transaction reference provided by the Merchant (reported in the plataforma de pagamentos da Adyen).<\/p>\n<\/td><\/tr>
\n
currency<\/code><\/p>\n<\/td>
\n
long<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
The transaction currency.<\/p>\n<\/td><\/tr>
\n
amount<\/code><\/p>\n<\/td>
\n
String<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
The transaction amount in minor units (100 is 1.00 with EUR). The Amount field should be a strong typed field with a string for currency code and a number (long) for the minor digits value (similar to the current API (of the terminal)).<\/p>\n<\/td><\/tr>
\n
specialOptions<\/code><\/p>\n<\/td>
\n
SpecialTenderOptions<\/p>\n<\/td>
\n
\"-x-\"<\/p>\n<\/td>
\n
Holds tender attributes.Activate, load, or refund a balance to a card by creating a special tender and passing the following values as the loadType<\/code> in special options:<\/p>\n
    \n
  • activate<\/strong> - Activates a gift card.<\/li>\n
  • load<\/strong> - Adds a balance to a gift card.<\/li>\n
  • merchandise_return<\/strong> -\u00a0Add a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes.<\/li>\n<\/ul>\n
    \n
    The activate and load values can be piped to chain the tasks by passing \"activate|load<\/strong>\".<\/p>\n
    <\/div><\/div>Perform a cash back or deactivate a card by creating a special tender and passing a redemptionType<\/code>\u00a0as a special option.\u00a0<\/p>\n
      \n
    • \n
      cashback -<\/strong> 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.<\/p>\n<\/li>\n
    • \n
      deactivate\u00a0<\/strong>- Deactivates a gift card.\u00a0\u00a0(Deactivate is not available for SVS).<\/p>\n<\/li>\n
    • \n
      gratuity<\/strong> - Used to provide a tip from a gift card. (For SVS cards only).<\/p>\n<\/li>\n<\/ul>\n
      \n
      The cashback and deactivate values can be piped to chain the tasks by passing\u00a0 \"cashback|deactivate<\/strong>\".<\/p>\n<\/div><\/div>\n<\/td><\/tr>
\n
handleReceipt<\/code><\/p>\n<\/td>
\n
Boolean<\/p>\n<\/td>
\n
\"-white_check_mark-\"<\/p>\n<\/td>
\n
Specifies that the POS handles and prints receipts. If omitted, it is required that the PED prints the receipt. If there is no printer unit, the transaction will fail.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n
Instantiate specialOptions<\/code> by assigning it to the result of the SpecialTender getterspecialtender.getSpecialOptions()<\/code><\/p>\n
SpecialOptions specialOptions = specialTender.getSpecialOptions();<\/code><\/pre>\n
Entry modes<\/h2>\n
The gift card can be presented in three ways:\u00a0<\/p>\n
    \n
  1. Swipe: the gift card is read using a magnetic stripe reader.<\/li>\n
  2. MKE on terminal: the card number is manually entered on the payment terminal. The tender should specify that it expects keyed entry on the terminal, and a card mask should be provided.<\/li>\n
  3. MKE on POS app: scan a barcode on the back of the card from the POS app. In this scenario, the card number, card mask, and expiry should be provided in special options.<\/li>\n<\/ol>\n
    You can specify entry modes by passing special tender options. See\u00a0Gift Cards<\/a>.\u00a0<\/p>\n
    Use put to set special options<\/h2>\n<\/colgroup>
    Name<\/th>Description<\/th><\/tr><\/thead>
    \n
    specialOptions.put<\/code><\/p>\n<\/td>
    		\n
    Allows you to add a special option as a key value pair.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n
    Add special options parameters to the specialTender<\/code>\u00a0using the specialOptions.put<\/code>\u00a0method.\u00a0<\/p>\n
    Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
    \n
    cardNumber\u00a0<\/code><\/p>\n<\/td>
    		\n
    String<\/p>\n<\/td>
    		\n
    \"-x-\"<\/p>\n<\/td>
    		\n
    The scanned number from the gift card. If this number:
    • Is passed from the POS, Keyed Entry will not be triggered on the PED.<\/li>
    • Is not passed from the POS Keyed Entry will be triggered on the PED.<\/li><\/ul><\/p>\n<\/td><\/tr>
    \n
    forceEntryMode<\/code><\/p>\n<\/td>
    		\n
    String<\/p>\n<\/td>
    		\n
    \"-white_check_mark-\"<\/p>\n<\/td>
    		\n
    The entry mode for the transaction.You can select from two entry modes: