Giftcard Hub 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 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.
Gift card Hub API Index
Provider
PUTCreate or update a gift card provider by IDGETGet a gift card provider by IDGETList all gift card providersDELETEDelete a gift card provider by ID
Transaction
POSTCreate a gift card at a gift card providerPOSTGet a gift card from a gift card providerGETGet a gift card from a gift card provider by IDPOSTCreate a gift card transactionGETGet a gift card transaction by IDGETList all gift card transactionsGETGet a gift card transaction authorizationPOSTCancel a gift card transactionGETList all gift card transactions cancellationsPOSTSettle a gift card transactionGETList all gift card transactions settlements
Endpoints
Provider
| Summary | Method | Path |
|---|---|---|
| List all gift card providers | GET | /api/giftcardproviders |
| Get a gift card provider by ID | GET | /api/giftcardproviders/{giftCardProviderId} |
| Create or update a gift card provider by ID | PUT | /api/giftcardproviders/{giftCardProviderId} |
| Delete a gift card provider by ID | DELETE | /api/giftcardproviders/{giftCardProviderId} |
Transaction
| Summary | Method | Path |
|---|---|---|
| Create a gift card at a gift card provider | POST | /api/giftcardproviders/{giftCardProviderId}/giftcards |
| Get a gift card from a gift card provider | POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/_search |
| Get a gift card from a gift card provider by ID | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId} |
| List all gift card transactions | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions |
| Create a gift card transaction | POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions |
| Get a gift card transaction by ID | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId} |
| Get a gift card transaction authorization | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization |
| List all gift card transactions settlements | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements |
| Settle a gift card transaction | POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements |
| List all gift card transactions cancellations | GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations |
| Cancel a gift card transaction | POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations |