API Reference

Integration Guides
Gift Card

In VTEX, gift cards are a payment option that allows brands to manage loyalty programs, create refund vouchers and accept physical gift cards in their online storefronts.

There are two ways a VTEX store can offer gift cards to their customers:

  • Using our native gift card provider
  • Integrating an external gift card provider

To use our native gift card solution, simply set it up as a payment method and your customers will be able to use their gift cards on your store's checkout. These gift cards are created and managed in your store's admin panel.

To integrate with an external gift card provider, however, you must develop a middleware according to our Gift Card Provider Protocol. This tutorial will present the main concepts and guide you through the steps required to complete this integration.

For example, you may use our native gift card provider and two external providers.

Structure of this guide

Gift Card system architectureAn overview of our system, so you understand its building blocks and how they interact with each other.
How do gift cards work?An explanation of our abstract model of a gift card, specifying the most important state variables and behaviors, so you can map these to the proper entities for your use case.
Integrating a new gift card providerWalkthrough of the API endpoints that your middleware must implement to adhere to our Gift Card Provider Protocol, along with activation instructions.
Managing gift cardsA final (optional) step covering how Gift Card Hub can be used to manage gift cards from multiple providers.

This guide is currently being written and published as content become available.

Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Suggest edits (Github)
On this page