Terminal-2 icon

Gift cards and other stored value cards

Use Terminal API for transactions with stored value cards like gift cards and mall cards.

Stored value cards are payment cards with a monetary value that is stored on the card itself instead of in a bank account. Examples are gift cards, mall cards, meal vouchers, and other prepaid cards. Some cards can be reused by transferring money to it, others are disposable cards that cannot be reloaded.

With a Terminal API integration you can accept gift cards issued by Givex, Intersolve, Stored Value Solutions (SVS), and Fiserv (formerly ValueLink).

We also support gift cards from local gift card providers in Denmark, France, The Netherlands, Norway, Sweden, and the United Kingdom. You can process payments with these gift cards, but you cannot do other gift card transactions.

With a Terminal API request from your POS app, you can make the following gift card transactions:

Transaction Givex SVS Fiserv Intersolve
Make a payment -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Activate with or without loading an amount -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Deactivate -white_check_mark- -x- -x- -x-
Cash out -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Check balance -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Load an amount -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Undo load transaction -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-
Refund -white_check_mark- -white_check_mark- -white_check_mark- -white_check_mark-

Requirements

Before you start integrating gift card transactions:

  • Add the payment method to your Adyen account. We will contact you if there are additional requirements before we can configure your account for gift card functionality.
  • Make sure that your integration supports partial payments.
  • Complete the onboarding process with the gift card provider.
  • Get your issued gift cards.

Card entry methods

To process a gift card transaction, we need to know the card details. There are several methods to obtain these, and in your gift card transaction request you need to specify the card entry method used:

  • Scan: you scan the gift card using a barcode scanner linked to the POS system. Then you specify the gift card details in the API request that you send to the terminal.
  • Swipe: when you send a request to the payment terminal, the shopper is prompted to swipe their card on the terminal. The terminal combines the request and the swiped card details to process the transaction, and sends the transaction result to the POS app.
  • Manual keyed entry (MKE): when you send a request to the payment terminal, the shopper is prompted to manually enter the gift card details on the terminal. The terminal combines the request and the entered details to process the transaction, and sends the transaction result to the POS app.

PIN options

If the gift card has a PIN code or another type of security code, the terminal will prompt the shopper to enter their PIN. Contact our Support Team if you want to enable the following PIN options:

  • PIN entry override: customize whether to prompt for a PIN or not, depending on the type of interaction, the entry mode, and the brand of the gift card. For example, you can choose to always have the shopper enter the PIN for a gift card payment, and never for a balance inquiry.
  • Store PIN: after the first gift card PIN entry, the terminal stores the PIN in the cache. For a limited amount of time, the terminal no longer prompts the shopper to enter the PIN when the card is used again, for example, to load funds. The terminal clears the PIN from the cache after a configurable time of 25 seconds to 30 minutes or as soon as any other payment or gift card is presented.

Stored Value API

Many gift card management operations can also be done using our Stored Value API instead of using Terminal API. You cannot make payments using the Stored Value API, but you can use this API as an alternative for any Terminal API request with a MessageCategory of StoredValue.

For example, instead of sending a Terminal API Activation request, you could use the Stored Value API /changeStatus endpoint.

With a point-of-sale integration, you already know the structure of the Terminal API and thus may prefer to do all point-of-sale gift card transactions using Terminal API.
If you also have an ecommerce integration, you may prefer to do these operations for both channels using the Stored Value API. You then use the Terminal API only for gift card payments, including cash-outs, and refunds.

Mall cards

Payment providers like Adyen process mall card or one4all card payments through the card scheme that the card is co-badged with, like Mastercard or Visa. To ensure that these payments are not refused, you must provide the card issuer with the scheme merchant ID (MID) that we use for your store. The card issuer then adds your MID to the list of allowed MIDs in their system.

You should reach out to the gift card issuer to find out what details they specifically need in order for your store to accept their cards. They may require more details about your stores than just the MID.

Send MIDs to the card issuer

To view the MIDs of your stores in the Customer Area, your user must have the following role:

  • View Acquiring Details

The MIDs are store-specific and are different for Mastercard and Visa.

  1. Get the card scheme:

    • Contact the card issuer and ask what card scheme the mall card is co-badged with.

    If there are multiple types of cards you want to accept, you must onboard with each card issuer separately.

  2. Get the MIDs:

    1. In your live Customer Area, go to Settings > Payment methods.

      If you do not see the MID column, select the gear icon and then enable the MID column.

    2. Filter the list to show your stores and the card scheme (Mastercard or Visa).
    3. For every store you want to include in the card program, get the MID that matches the card scheme.
  3. Send the MIDs to the card issuer.
    They will add the MIDs to the list of allowed stores, so that the mall card payments don't get refused.

Next steps

See also