vtex.local – GiftCard-Hub-API

OpenAPI apis-guru

ℹ️ Check the new . 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.

Homepage: https://api.apis.guru/v2/specs/vtex.local:GiftCard-Hub-API/1.0.json
Provider: vtex.local:GiftCard-Hub-API / GiftCard-Hub-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/GiftCard-Hub-API/1.0/openapi.yaml

Tools (17)

Extracted live via the executor SDK.

provider.createUpdateGiftCardProviderbyId

Create or update a giftcard provider from a store.
provider.deleteGiftCardProviderbyId

Delete a giftcard provider from a store.
provider.getGiftCardProviderbyId

Returns a giftcard provider from a store.
provider.listAllGiftCardProviders

Returns a collection of giftcard providers from a store.
transaction.createGiftCardCancellationTransaction

Creates a cancellation transaction to a giftcard.
transaction.createGiftCardinGiftCardProvider

Creates a giftcard in a giftcard provider.
transaction.createGiftCardSettlementTransaction

Creates a settlement transaction to a giftcard.
transaction.createGiftCardTransaction

Creates a transaction to a giftcard.
transaction.getGiftCardAuthorizationTransaction

Returns the transaction authorization info.
transaction.getGiftCardfromGiftCardProvider

Returns all giftcards from a giftcard provider according to the filters.
transaction.getGiftCardfromGiftCardProviderbyId

Returns a specific giftcard from a giftcard provider.
transaction.getGiftCardTransactionbyId

Returns a specific transaction from a giftcard.
transaction.listAllGiftCardCancellationTransactions

Returns a collection of cancellation transactions from a giftcard.
transaction.listAllGiftCardSettlementTransactions

Returns a collection of settlement transactions from a giftcard.
transaction.listAllGiftCardTransactions

Return all transaction from a giftcard.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools