Using our API for a custom integration

If you have your own platform you can use our Developer API to integrate your system with ours. 

The typical use case involves accepting gift cards as payment/discount against an online order, subscription, service or booking. You can achieve that and lots more with our API.

How to accept our gift cards in your checkout

Please note: This requires that you have full developer access to your online checkout system. If you use an off the shelf system (like Shopify, WooCommerce etc...) we have specially built integrations for them, and more...

To accept gift cards balances on your custom e-commerce checkout all you need to do is have an input field (or use the existing typical "enter your promo code here..." field) that asks for our 5 character alpha-numeric, unique gift card code.

The process to accept our gift card balances against an order/booking in your system etc... is typically as follows: 

1. Ask us for the balance via our API

When you have that you will need to validate the gift card exists and determine the balance on it. To do that you call " Get a gift card by code".

2. Accept the balance in your system

We return a full JSON object defining 2 key parts of information, one is whether the gift card can be redeemed (true or false), the other is the remaining value on the gift card in your Gift Up! account's currency. 

Process the order as you normally would, but discounting by an amount up to the gift card remaining balance amount.

3. Instruct us to redeem some money off the gift card via our API

Once you've accepted the order in your system you will want to tell us to redeem an amount off of the gift card so that the customer cannot use it again straight away. To do this you can call either " Redeem a gift card in full" or "Redeem a gift card" for a partial or full redemption.

We have 2 ways to redeem an amount of a gift card which means that you can, if you choose, allow customers to use their balance over many transactions.

How to accept our gift cards against a subscription/customer account

You might have a different use in mind: one where you apply a gift card balance against an account your customers hold, or against a subscription/plan somewhere. This follows the basic steps above and can be accommodated easily.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us