Using our Standalone solution?
Our Standalone solution supports credit and debit cards and wallet payment methods.
Gift cards are a type of stored value cards: Payment cards with a monetary value that is stored on the card itself instead of in a bank account. Some cards can be reused by transferring money to it, others are disposable cards that can't be reloaded.
We also support gift cards from key 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 can't do other gift card transactions.
With a Terminal API request from your cash register, you can make the following gift card transactions:
Activate: Enables the gift card for other transactions. You can optionally load an initial balance to the card when you activate it.
After the card is activated, you can make the following transactions:
- Make a payment: Make a full or partial payment with a gift card.
- Check the balance: Query the remaining balance of the gift card.
- Load a balance: Add funds to the balance of the gift card.
- Refund: Make an unreferenced refund to return funds to the gift card. You can also make a referenced refund, linking the refund to a payment made with the gift card.
- Deactivate or cash out: Disable the card by deactivating it or cashing out the remaining funds.
- Undo previous load transaction: Undo the most recent load transaction on a gift card, provided it took place in the past 24 hours.
Before you begin
Before you make any gift card transactions, make sure that you have:
- Built an integration that can make a payment.
- Completed the onboarding process with your gift card provider.
- Added 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.
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 cash register. Then you specify the gift card details in the request that you send to the terminal.
- Swipe: When you send a request to the payment terminal, the cash register prompts the shopper 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 cash register.
- Manual keyed entry (MKE): When you send a request to the payment terminal, the cash register prompts the shopper 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 cash register.
If the gift card has a PIN code or other type of security code, the terminal will prompt the shopper to enter their PIN. Contact our POS Support Team if you want to override PIN entry.
Stored Value API
There are some gift card transactions that you can also do using our Stored Value API. This is a JSON-only API that's the same for point of sale and web. You can't make payments with this API, but you can use it for the following transactions:
- Load funds
- Check the balance
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 online-payments integration, you may prefer to do these transactions for both point of sale and web using the Stored Value API. You'd still use the Terminal API, but only for payment-related transactions.
Activate gift card
Activate a gift card, so it can be used by a shopper.
Make gift card payment
Make a point-of-sale gift card payment.