Accepting a gift card or membership credit as payment

Allowing your customers to use their gift cards or membership credits on a website or in person can be done simply and require as few as two API requests.

To get started you'll need an API key as the lookup and redeem API endpoints are within the Organisation API.

1

Collect the gift card or membership code

The first step when accepting a gift card as a form of payment is to collect the gift card code from the customer, the format of the code will vary depending on the store settings at the time the code was generated, you should check the store settings before building any validation.

If the interaction is being completed by the customer and via a website, we recommend collecting the gift card during the basket or checkout flow, either right at the start or alongside other payment method options.

If the code is being used in person, through an EPOS for example then beside manually typing the code in, our physically delivered gift cards can support barcode and QR codes, NFC and magstripe, which methods are available will depend on what was selected at the time of production as magnetic stripes and NFC can be more expensive.

2

Check the gift card or membership code

Once the gift card code has been retrieved, the first step is to make the lookup call. The result of that call will tell you if the gift card exists, its status and balance. If its not valid then present an appropriate error message to the customer or user.

If the gift card is valid, the gift card balance should be applied against the customers checkout total.

3

Redeem the gift card or membership code

Once the customer has confirmed their order, either paying the entire amount with the gift card or a combination of gift card and something else such as a debit or credit card, you need to make use the redeem API endpoint — This will update the gift card balance and status as required, this should be done as soon as possible after the order is confirmed.