GiftCard Hub API
>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
>ℹ️ 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 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.
Endpoints 15
Provider
- GETList All GiftCard Providers
/giftcardprovidersReturns a collection of giftcard providers from a store. - PUTCreate/Update GiftCard Provider by ID
/giftcardproviders/:giftCardProviderIDCreate or update a giftcard provider from a store. - DELETEDelete GiftCard Provider by ID
/giftcardproviders/:giftCardProviderIDDelete a giftcard provider from a store. - GETGet GiftCard Provider by ID
/giftcardproviders/:giftCardProviderIdReturns a giftcard provider from a store.
Transaction
- POSTCreate GiftCard in GiftCard Provider
/giftcardproviders/:giftCardProviderID/giftcardsCreates a giftcard in a giftcard provider. - POSTGet GiftCard from GiftCard Provider
/giftcardproviders/:giftCardProviderID/giftcards/_searchReturns all giftcards from a giftcard provider according to the filters. - GETGet GiftCard from GiftCard Provider by ID
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardIDReturns a specific giftcard from a giftcard provider. - GETList All GiftCard Transactions
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactionsReturn all transaction from a giftcard. - POSTCreate GiftCard Transaction
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactionsCreates a transaction to a giftcard. - GETList All GiftCard Cancellation Transactions
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:tId/cancellationsReturns a collection of cancellation transactions from a giftcard. - POSTCreate GiftCard Cancellation Transaction
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:tId/cancellationsCreates a cancellation transaction to a giftcard. - GETList All GiftCard Settlement Transactions
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:tId/settlementsReturns a collection of settlement transactions from a giftcard. - POSTCreate GiftCard Settlement Transaction
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:tId/settlementsCreates a settlement transaction to a giftcard. - GETGet GiftCard Transaction by ID
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:transactionIDReturns a specific transaction from a giftcard. - GETGet GiftCard Authorization Transaction
/giftcardproviders/:giftCardProviderID/giftcards/:giftCardID/transactions/:transactionID/authorizationReturns the transaction authorization info.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br/api- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 15 operations on 11 pathsGET 8POST 5PUT 1DELETE 1
- Main resources
- Transaction 11Provider 4
- Response formats
text/plain- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the GiftCard Hub API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the GiftCard Hub API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List All GiftCard Providers” (GET /giftcardproviders), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the GiftCard Hub API?
>ℹ️ Check the new [Payments onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the… It is listed under Other and has 15 endpoints.
Who publishes the GiftCard Hub API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the GiftCard Hub API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the GiftCard Hub API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the GiftCard Hub API have?
15 operations on 11 paths (8 GET, 5 POST, 1 PUT, 1 DELETE). The largest groups are Transaction, Provider.
Is forking the GiftCard Hub API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.