APIHub
Back to Explore

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 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 regist

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

3255ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/giftcardproviders

List All GiftCard Providers

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • REST-Range (header) — Pagination control. This query variable must follow the format _resources={from}-{to}_.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
DELETE

/giftcardproviders/{giftCardProviderID}

Delete GiftCard Provider by ID

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
PUT

/giftcardproviders/{giftCardProviderID}

Create/Update GiftCard Provider by ID

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
POST

/giftcardproviders/{giftCardProviderID}/giftcards

Create GiftCard in GiftCard Provider

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
POST

/giftcardproviders/{giftCardProviderID}/giftcards/_search

Get GiftCard from GiftCard Provider

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • REST-Range (header, required) — Range of documents to show.
  • giftCardProviderID (path, required) — Gift Card provider's ID.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}

Get GiftCard from GiftCard Provider by ID

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions

List All GiftCard Transactions

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
POST

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions

Create GiftCard Transaction

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{tId}/cancellations

List All GiftCard Cancellation Transactions

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • tId (path, required) — Transaction ID generated by the provider. It is different from the `transactionID` generated by VTEX.
POST

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{tId}/cancellations

Create GiftCard Cancellation Transaction

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • tId (path, required) — Transaction ID generated by the provider. It is different from the `transactionID` generated by VTEX.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{tId}/settlements

List All GiftCard Settlement Transactions

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • tId (path, required) — Transaction ID generated by the provider. It is different from the `transactionID` generated by VTEX.
POST

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{tId}/settlements

Create GiftCard Settlement Transaction

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • tId (path, required) — Transaction ID generated by the provider. It is different from the `transactionID` generated by VTEX.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}

Get GiftCard Transaction by ID

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • transactionID (path, required) — Gift Card transaction ID.
GET

/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}/authorization

Get GiftCard Authorization Transaction

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderID (path, required) — Gift Card provider's ID.
  • giftCardID (path, required) — Gift Card ID.
  • transactionID (path, required) — Gift Card transaction ID.
GET

/giftcardproviders/{giftCardProviderId}

Get GiftCard Provider by ID

  • Accept (header, required) — Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.
  • Content-Type (header, required) — The Media type of the body of the request. Default value for payment provider protocol is application/json.
  • X-VTEX-API-AppKey (header, required) — VTEX API AppKey
  • X-VTEX-API-AppToken (header, required) — VTEX API AppToken
  • giftCardProviderId (path, required) — Gift Card provider's ID.

15 endpoints auto-detected

Authentication

This API uses an API key, passed in the "X-VTEX-API-AppKey" header. No OAuth required.

curl -X GET \
  "https://vtex.local/giftcardproviders" \
  -H "X-VTEX-API-AppKey: YOUR_API_KEY"

vtex.local · HTTPS only