Giftcard API

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 is a payment method configured as a cash value associated with a client. It is used to grant a discount on the value of the order at the store. A gift card works as a payment method, not a promotion.

In VTEX's native gift card system, you can choose to create a new gift card either through VTEX Admin or API. However, there are specific conditions to be observed when generating gift cards by one of these two methods.

Specifications	VTEX Admin	Giftcard API
Initial value	You can create gift cards value with any value.	All gift cards are generated with no value (balance = 0). After its creation, you need to use VTEX Admin or the Create a gift card transaction to add any balance amount.
Ownership restriction	You can create gift cards with or without a user assigned to them.	All gift cards must be created with a profileId associated to them.
User data identification	Customer ID (data that identifies a specific client, such as CPF/CNPJ in Brazil).	profileId (data that identifies a specific client)
Additional Settings	You can use checkboxes to select whether a gift card will be: Restricted (only a specific customer ID can use this gift card), Reloadable (balance can be changed while it is still active), or Reusable (available for making new purchases with this gift card until its value is completely used up).	You can use the following fields to configure the same conditions applied in VTEX Admin: restrictedToOwner, multipleCredits, and multipleRedemptions.

All Giftcard API endpoints are limited to 500 concurrent requests and 5000 requests per minute.

Giftcard API Index

Giftcard

• POST Create a gift card
• GET Get a gift card by ID
• POST List all gift cards

Transaction

• 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