Skip to main content

Giftcards

docs image

Giftcards

Configuring giftcards

EVA supports all the giftcards you could possibly ever want. We support them: we are not a giftcard provider.

When it comes to giftcards, we make a very clear distinction between physical giftcards and digital giftcards.

Physical giftcards keep stock and require a serial number Digital giftcards are sent out via mail.

When describing giftcards, we emphasize the difference between physical and digital giftcards.

Additionally, we also distinguish between selling giftcards and using them as a payment method. You may want to sell giftcards, but not accept them as a form of payment. In any case, both situations require giftcard configuration, which will be covered here.

Authorization

In order to be able to access this chapter, you need the GiftCardConfigurations permission.

Giftcard configurations

A giftcard configuration essentially describes your giftcard using the following properties:

PropertyDescription
NameName for your giftcard.
HandlerExplained later on.
Card typeSome handlers support multiple card types.
Usage typeWhether you want to sell cards, or use them as payment.

Handlers

Your handler is like your giftcard 'provider'. We've set up a generic giftcard implementation that can be used to connect any giftcard you want – you just have to do it yourself. This handler is called APIGIFTCARD.

Available giftcard configurations

If you want to view the currently available configurations in your EVA environment, navigate to the Giftcards chapter in the Financials module in Admin Suite.


Creating configurations

Start off by clicking the '+' icon on the overview page.


  • Allow refund without transaction: Checking this will enable POS to display a button for emptying a giftcard when checking its balance (accessed through More options). Using that button will subsequently initiate the creation and checkout process for a new refund order.
  • Allow currency conversion: Checking this will allow for the giftcard to be used in OUs with a different default currency.

APIGIFTCARD

To use the APIGIFTCARD handler, you need to build an integration with a giftcard provider that can receive certain requests and send the correct responses. The only difference between physical and digital giftcards is that physical giftcards are 'activated' and digital giftcards 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 giftcard handler.


OptionDescription
Base URLThe URL that EVA will use for the various giftcard operations.
UsernameThe 'username' used for the authentication at the handler.
PasswordThe 'password' used for the authentication at the handler.
Timeout (Seconds)The time the call is valid before timing out.

Configuring alternative handlers

When setting up Adyen payments, many of the configurations for the Adyen SVS giftcard are already established.

SettingDescription
App:GiftCard:DefaultTypeAdyenStoredValue
AdyenStoredValue:ApiUrlThis is the URL required for the activation of giftcards.
note

The use of these settings assumes that you will be using the CheckoutAPI for refunds and captures. However, you can read more about the basic Adyen integration and the CheckoutAPI in the following docs: Payments using Adyen