The VTEX Gift Card Hub API provides a central integration point for managing gift card providers on the VTEX platform. It enables merchants to list, activate, and deactivate gift card providers, and process gift card transactions through a unified interface.
openapi: 3.0.0
info:
title: VTex GiftCard Hub API
description: ">ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). 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.\r\n\r\nThe Gift Card Hub API allows interactions with all Gift card providers registered to a store from a single point.\r\n\r\nGift card providers are systems capable of providing cards to be used in the buying process.\r\n\r\nThe following is the sequence diagram that represents calls in the purchase closing process.\r\n\r\n\r\n**Checkout + Gateway**: Systems responsible for the sale and for processing orders and payments.\r\n\r\n**Gift Card Hub**: System responsible for managing multiple registered Gift card providers for a store.\r\n\r\n**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.\r\n\r\n## GiftCard Hub API Index\r\n\r\n### Provider\r\n\r\n- `PUT` [Create/Update GiftCard Provider by ID](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-)\r\n- `GET` [Get GiftCard Provider by ID](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-)\r\n- `GET` [List All GiftCard Providers](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders)\r\n- `DELETE` [Delete GiftCard Provider by ID](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#delete-/api/giftcardproviders/-giftCardProviderId-)\r\n\r\n### Transaction\r\n\r\n- `POST` [Create GiftCard in GiftCard Provider](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#post-/api/giftcardproviders/-giftCardProviderId-/giftcards)\r\n- `POST` [Get GiftCard from GiftCard Provider](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#post-/api/giftcardproviders/-giftCardProviderId-/giftcards/_search)\r\n- `GET` [Get GiftCard from GiftCard Provider by ID](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-)\r\n- `POST` [Create GiftCard Transaction](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#post-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions)\r\n- `GET` [Get GiftCard Transaction by ID](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-transactionId-)\r\n- `GET` [List All GiftCard Transactions](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions)\r\n- `GET` [Get GiftCard Transaction Authorization](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/authorization)\r\n- `POST` [Cancel GiftCard Transaction](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#post-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/cancellations)\r\n- `GET` [List All GiftCard Transactions Cancellations](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/cancellations)\r\n- `POST` [Settle GiftCard Transaction](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#post-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/settlements)\r\n- `GET` [List All GiftCard Transactions Settlements](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/settlements)"
contact: {}
version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
description: VTEX server URL.
variables:
accountName:
description: Name of the VTEX account. Used as part of the URL.
default: apiexamples
environment:
description: Environment to use. Used as part of the URL.
enum:
- vtexcommercestable
default: vtexcommercestable
paths:
/api/giftcardproviders:
get:
tags:
- Provider
summary: VTex List All GiftCard Providers
description: "Returns a collection of gift card providers from a store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **View Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: ListAllGiftCardProviders
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: REST-Range
in: header
description: Pagination control. This query variable must follow the format `_resources={from}-{to}_`.
required: false
style: simple
schema:
type: string
default: resources=0-49
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: Gift card provider identification.
serviceUrl:
type: string
description: URL from the provider.
oauthProvider:
type: string
description: Provider's authentication.
preAuthEnabled:
type: boolean
description: Related to the pre-authorization that can happen on the transaction generated through the provider.
cancelEnabled:
type: boolean
description: Indicates whether it is possible to cancel the transaction, generated through the provider.
_self:
type: object
description: Object that carries an auto reference from the provider at the Hub (on its API).
properties:
href:
type: string
description: This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.
example:
- id: GiftCardExample
serviceUrl: https://api.vtex.com.br/basedevmkp
oauthProvider: vtex
preAuthEnabled: true
cancelEnabled: true
_self:
href: cosmet/giftcardproviders/GiftCardExample
- id: GiftCardExample2
serviceUrl: https://giftcard--cosmetics2.myvtex.com/my-provider
oauthProvider: vtex
caption: My Updated Gift Card Provider
preAuthEnabled: true
cancelEnabled: true
_self:
href: cosmet/giftcardproviders/GiftCardExample2
deprecated: false
/api/giftcardproviders/{giftCardProviderId}:
get:
tags:
- Provider
summary: VTex Get GiftCard Provider by ID
description: "Returns a gift card provider from a store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **View Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: GetGiftCardProviderbyID
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Gift card provider identification.
serviceUrl:
type: string
description: URL from the provider.
oauthProvider:
type: string
description: Provider's authentication.
caption:
type: string
description: Description about the provider.
preAuthEnabled:
type: boolean
description: Related to the pre-authorization that can happen on the transaction generated through the provider.
cancelEnabled:
type: boolean
description: Indicates whether it is possible to cancel the transaction, generated through the provider.
_self:
type: object
description: Object that carries an auto reference from the provider at the Hub (on its API).
items:
type: object
properties:
href:
type: string
description: This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.
example:
id: GiftCardExample
serviceUrl: https://api.vtex.com.br/basedevmkp
oauthProvider: vtex
caption: My Updated Gift Card Provider
preAuthEnabled: true
cancelEnabled: true
_self:
href: cosmet/giftcardproviders/GiftCardExample
'500':
description: Object reference not set to an instance of an object (The gift card provider described does not exist).
deprecated: false
put:
tags:
- Provider
summary: VTex Create/Update GiftCard Provider by ID
description: "Create or update a gift card provider from a store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: Create/UpdateGiftCardProviderbyID
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
requestBody:
content:
application/vnd.vtex.giftcardproviders.v1+json:
schema:
$ref: '#/components/schemas/CreateUpdateGiftCardProviderbyIDRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Gift card provider identification.
serviceUrl:
type: string
description: URL from the provider.
oauthProvider:
type: string
description: Provider's authentication.
preAuthEnabled:
type: boolean
description: Related to the pre-authorization that can happen on the transaction generated through the provider.
cancelEnabled:
type: boolean
description: Indicates whether it is possible to cancel the transaction, generated through the provider.
_self:
type: object
description: Object that carries an auto reference from the provider at the Hub (on its API).
items:
type: object
properties:
href:
type: string
description: This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.
example:
id: GiftCardExample3
serviceUrl: https://api.vtex.com.br/basedevmkp
oauthProvider: vtex
preAuthEnabled: true
cancelEnabled: true
_self:
href: cosmetics2/giftcardproviders/GiftCardExample3
deprecated: false
delete:
tags:
- Provider
summary: VTex Delete GiftCard Provider by ID
description: "Delete a gift card provider from a store.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: DeleteGiftCardProviderbyID
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
'404':
description: |
The gift card provider described does not exist.
deprecated: false
/api/giftcardproviders/{giftCardProviderId}/giftcards:
post:
tags:
- Transaction
summary: VTex Create GiftCard in GiftCard Provider
description: "Creates a gift card in a gift card provider.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: CreateGiftCardinGiftCardProvider
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
requestBody:
content:
application/vnd.vtex.giftcardproviders.v1+json:
schema:
$ref: '#/components/schemas/CreateGiftCardinGiftCardProviderRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Gift card identification.
emissionDate:
type: string
description: Gift card emission date.
expiringDate:
type: string
description: Gift card expiration date.
caption:
type: string
description: Field to be filled in if a loyalty program must be created for the gift card.
provider:
type: string
description: Provider name.
discount:
type: boolean
deprecated: true
currencyCode:
type: string
description: Currency code in ISO 4217.
transaction:
type: object
description: Transaction information.
properties:
href:
type: string
description: Gift card resource URL. The number described in the URL refers to the gift card identification.
example:
id: '38'
emissionDate: '2023-06-27T17:02:19.17'
expiringDate: '2023-09-27T17:02:19.17'
caption: Loyalty Program
provider: GiftCardExample
discount: 'false'
currencyCode: USD
transactions:
href: cosmetics2/giftcardproviders/GiftCardExample/giftcards/38/transactions
deprecated: false
/api/giftcardproviders/{giftCardProviderId}/giftcards/_search:
post:
tags:
- Transaction
summary: VTex Get GiftCard from GiftCard Provider
description: "Returns all gift cards from a gift card provider according to the filters.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **View Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: GetGiftCardfromGiftCardProvider
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: REST-Range
in: header
description: Pagination control. This query variable must follow the format `_resources={from}-{to}_`.
required: false
style: simple
schema:
type: string
default: resources=0-49
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
requestBody:
content:
application/vnd.vtex.giftcardproviders.v1+json:
schema:
$ref: '#/components/schemas/GetGiftCardfromGiftCardProviderRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: Gift card identification.
provider:
type: string
description: Gift card provider name.
balance:
type: number
description: Gift card current balance.
_self:
type: object
description: Object that carries an auto reference from the provider at the Hub (on its API).
properties:
href:
type: string
description: This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.
example:
- id: '262498'
provider: GiftCardExample
balance: 45.5
_self:
href: cosmet/giftcardproviders/GiftCardExample/giftcards/262498
deprecated: false
/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}:
get:
tags:
- Transaction
summary: VTex Get GiftCard from GiftCard Provider by ID
description: "Returns a specific gift card from a gift card provider.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **View Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
operationId: GetGiftCardfromGiftCardProviderbyID
parameters:
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: Accept
in: header
description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: giftCardProviderId
in: path
description: Gift card provider identification.
required: true
style: simple
schema:
type: string
example: GiftCardExample
- name: giftCardId
in: path
description: Gift card identification.
required: true
style: simple
schema:
type: string
example: '5'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Gift card identification.
redempt
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-gift-card-hub-openapi-original.yml