GiftCard Hub API - Overview


Onboarding guide

Check the new Payments onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.

The Gift Card Hub API allows interactions with all Gift Card providers registered to a store from a single point.

Gift Card providers are systems capable of providing cards to be used in the buying process.

The following is the sequence diagram that represents calls in the purchase closing process.


Checkout + Gateway: Systems responsible for the sale and for processing orders and payments.

Gift Card Hub: System responsible for managing multiple registered Gift Card providers for a store.

Gift Card Provider: System responsible for providing the Gift Cards available to the user not closing a purchase. This system can be implemented by third parties.