Giftcards
EVA supports all gift cards you could possibly ever want. We support them, we are not a gift card provider. When first starting out, we built some dedicated integrations with certain gift card providers. However, as we grew, we got more requests for for more integrations with more providers. In order for us to scale more easily, we built a generic gift card integration which can be used to connect any provider we don't support.
When it comes to gift cards, we make a very clear distinction between physical gift cards and digital gift cards. Physical gift cards keep stock and require a serial number, digital gift cards are sent out via mail. This document has separate sections for physical and digital gift cards.
Additionally, we make a distinction between selling gift cards, and using gift cards as a payment method. Sometimes, you maybe want to sell gift cards, but not accept them for payments. Both situations require a gift card configuration though.
Gift card configurations
A gift card configuration essentially describes your gift card using the following properties:
| Property | Description |
|---|---|
| Name | Name for your gift card. |
| Handler | Explained later on. |
| Card type | Some handlers support multiple card types. |
| Usage type | Whether you want to sell cards, or use them as payment. |
Handlers
Your handler is kind of your gift card 'provider'. We used to have a lot of these, but the requests to add more and more handlers kept rolling in. We then killed of most of our available handlers and set up a generic gift card implementation that can be used to connect any gift card you want. You just have to do it yourself. This handler is called APIGIFTCARD.
Available gift card configurations
In case you want to view the available configurations in your EVA environment, you can go to the Gift cards chapter in the Financials module in Admin Suite.
In order to be able to access this chapter, you need the GiftCardConfigurations permission.
Creating configurations
Start off by hitting the '+' icon on the overview page.
APIGIFTCARD
To use the APIGIFTCARD handler, you need to build an integration with a gift card provider that can receive certain requests and send the correct responses. The only difference between physical and digital gift cards is that physical gift cards are 'activated' and digital gift cards are 'issued'.
If you selected the 'APIGIFTCARD' option in the creation window in Admin Suite, the window will expand to give you the needed options to connect with your gift card handler.
| Option | Description |
|---|---|
| Base URL | The URL that EVA will use for the various gift card operations |
| Username | The 'username' used for the authentication at the handler |
| Password | The 'password' used for the authentication at the handler |
| Timeout (Seconds) | The time the call is valid before time-outing |
Configuring alternative handlers
Most of the settings for the Adyen SVS gift card are already set when configuring Adyen payments in general.
| Setting | Description |
|---|---|
| App:GiftCard:DefaultType | AdyenStoredValue |
| AdyenStoredValue:ApiUrl | This is the URL required for the activation of gift cards. |
| GiftCards:Payment:DenyPayingForGiftCards | Set to true to prevent paying with gift cards to purchase gift cards. |
The use of this single setting assumes that you will be using the CheckoutAPI for refunds and captures. But you can read more about the basic Adyen integration and the CheckoutAPI in the following docs: Payments using Adyen
Accepting gift cards as payment
First, make sure to have a gift card configuration in place that allows for payments (usage type 'Payment').
When you have that in place, we can create the following payment method:
Under Options we can customize our payment method a bit. Just make sure to select your previously configured gift card configuration from the Giftcard configuration dropdown list.
When using the Adyen SVS gift card, the payment will run via the Adyen payment methods, for example Adyen_CheckoutAPI_Giftcard
The gift card payment option should now be available in the Companion app and POS for your specified organization units.
Selling gift cards
In order to be able to sell gift cards, we have to upload/import a gift card product. Usually we import products using our ImportProducts service, which doesn't necessarily make sense for gift card products but we can very easily create a manual request. We have some examples ready for you under Creating Gift cards.
As we do not yet have any method of linking products to a gift card configuration in ImportProducts, these imports will automatically generate their own gift card configuration. Make sure to check up on that configuration after import to set the right configurations.
Refunding gift cards
Although refunding gift cards with a receipt/original order can be done easily - as shown here, setting up a refund flow for (digital) gift cards without them takes a few more steps.
If you're selling digital gift cards in a country which requires you to refund them at sight, please see the following steps in Refunding a digital gift card.