Gift Card API

A gift card API (Application Programming Interface) is a tool used by developers to integrate the ordering and sending of gift cards directly into their own software, app, or platform. It lets businesses deliver digital gift cards either in-app or via other channels, and ideally also gives them access to tracking features and a wide global catalog of gift cards.

A good gift card API will also let you send prepaid cards like those from Visa® and Mastercard.®

API keys and tokens are used to authenticate and authorize access to an API. In this case, you’ll use your API key to enable your application to securely interact with Giftbit’s gift card API. Then you’ll use your API key for tasks like ordering, tracking, and sending digital gift cards or prepaid cards.

To access your key, log in to your account and navigate to Account → API Keys.

Developers can start using the Giftbit gift card API by reading the API documentation, and then setting up their free Sandbox account. There are no API usage fees.

If you are a program manager or other stakeholder, simply direct your developer to this Giftbit API page.

Everyone is also free to book time with Matt Brossard, our integration specialist. Our team has dedicated technical and business resources to help you determine the best path to get started.

To access an API token for the Giftbit Testbed environment, sign up for your Testbed account and visit the Account → API keys section.

When you’re ready to launch your integration, sign up for a free Giftbit account and contact sales@giftbit.com to signal production readiness. We’ll then enable permissions so you can generate an API token in your production account. Permissions are typically enabled within 24 hours. 

You can attach any custom information you want to associate with a reward, such as time stamps, transaction numbers, campaign IDs, or user identifiers by embedding those details in the user supplied ID. The ID parameter is a custom identifier used in your API requests that accepts a long string. 

Each request ID is idempotent, meaning every value needs to be unique from request to request. Keep this in mind when designing the ID you will include in your API requests.

Yes, you can pull order history and status from the API.

Specifically, you can access order processing status and delivery information using the /campaign endpoint. 

You can pull campaign records using either your request ID, or the system generated UUID provided by Giftbit when you create a reward. 

Similarly, you can pull individual reward records using either your request ID, or the UUID provided by Giftbit. 

And you can access redemption status from the /gifts endpoint. 

Refer to the API documentation  for more instructions on how to utilize appropriate record identifiers in GET requests, or email hello@giftbit.com. 

By default, all rewards delivered using the API are non-expiring. You’ll also have the option to provide an expiration date in your API call, to limit the period in which your recipients can choose a reward or reveal a card.

Learn more about catalog features like Standard and Promotional reward options here.

The Giftbit gift card and prepaid card API allow for link-based reward delivery. There are two types of links you can use here: direct_link or shortlink.

Direct links go straight to the reward itself, so you don’t need to add extra messaging or branding. They’re best for tasks like merging into emails delivered by a system other than Giftbit, where you don’t need to provide your recipients much added context.

Use the /direct_links endpoint to request direct link rewards.

Alternatively, shortlinks will first direct your recipients to a landing page which includes your company logo, as well as your custom message. These are often used for delivering shorter messages via SMS or social channels, or any time you need to provide your recipients more context.

Use the /campaign endpoint along with the delivery_type: SHORTLINK property to request shortlink rewards.

Many developers use the Giftbit API specifically because they need white label options. To create a white label experience, we recommend using direct links, which are fully embeddable, have neutral looking presentation, and contain minimal instances of references to Giftbit. 

Reach out to Matt if you have any more questions.