Skip to main content

Generic gift card interface

EVA has a generic interface which can be used to integrate gift card providers. This involves a set of default requests and responses that need to be accounted for in the integration.

The identifier used for this gift card method is APIGIFTCARD.

Note

Before starting to work on this integration, make sure to have a valid giftcard configuration for APIGIFTCARD.

EVA will call different endpoints for different operations, all calls are PUSH and contain application/json in the request headers. They also expect application/json in the response headers. Below is a list of requests that will be sent out by EVA, and the responses that are expected.

Used to fetch the current balance of a gift card.

baseurl/card-info
{
"CardNumber": "123445643",
"Pin": "2342"
}

Response
{
"IsSuccess": true,
"Balance": 10.00,
"CurrencyID": "EUR"
}

Business rules

It is possible to include certain business rules in your integration:

ValueUsage
ActivateValueMinMinimum activation amount (e.g. 24.95)
ActivateValueMaxMaximum activation amount
PurchaseValueMinMinimum purchase amount
PurchaseValueMaxMaximum purchase amount
ReloadableWhether the card is reloadable
RefundableWhether the card is refundable

To make these business rules known, add the rules in the card-info response like so:

baseurl/card-info response
{
"IsSuccess": true,
"Balance": 10.00,
"CurrencyID": "EUR",
"BusinessRules": {
"ActivateValueMin": 24.95
}
}