Giftcard Provider Protocol - 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 Provider Protocol is a set of definitions to help you integrate your Gift Card API into VTEX platform.

To achieve this, you need to implement a web API (REST) following the specifications from this documentation and configure your provider in your store using Gift Card Hub API.

Common parameters in the documentation

{{providerApiEndpoint}} Provider's endpoint for the implementation (mandatory)
{{X-PROVIDER-API-AppKey}} The AppKey configured by the merchant (optional)
{{X-PROVIDER-API-AppToken}} The AppToken configured by the merchant (optional)