Giftcard Provider Protocol

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.

Giftcard Provider Protocol API Index

Gift Cards

Transactions

POST Create a gift card transaction
GET Get a gift card transaction by ID
GET List all gift card transactions
GET Get a gift card transaction authorization
POST Cancel a gift card transaction
GET List all gift card transactions cancellations
POST Settle a gift card transaction
GET List all gift card transactions settlements

Endpoints

Gift Cards

Summary	Method	Path
List all gift cards	POST	`/giftcards/_search`
Get a gift card by ID	GET	`/giftcards/{giftCardId}`
Create a gift card	POST	`/giftcards`

Transactions

Summary	Method	Path
Create a gift card transaction	POST	`/giftcards/{giftCardId}/transactions`
List all gift card transactions	GET	`/giftcards/{giftCardId}/transactions`
Get a gift card transaction by ID	GET	`/giftcards/{giftCardId}/transactions/{transactionId}`
Get a gift card transaction authorization	GET	`/giftcards/{giftCardId}/transactions/{transactionId}/authorization`
Cancel a gift card transaction	POST	`/giftcards/{giftCardId}/transactions/{transactionId}/cancellations`
List all gift card transactions cancellations	GET	`/giftcards/{giftCardId}/transactions/{transactionId}/cancellations`
Settle a gift card transaction	POST	`/giftcards/{giftCardId}/transactions/{tId}/settlements`
List all gift card transactions settlements	GET	`/giftcards/{giftCardId}/transactions/{tId}/settlements`