APIHub
Back to Explore

GiftCard API

>ℹ️ Onboarding guide > > Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/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 is a payment method configured as a cash value as

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/giftcards

Create GiftCard

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

/giftcards/_search

Get GiftCard using JSON

  • 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) — PaginationB control.B ThisB queryB variableB mustB followB theB formatB _resources={from}-{to}_.
GET

/giftcards/{giftCardID}

Get GiftCard 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
  • giftCardID (path, required)
GET

/giftcards/{giftCardID}/transactions

Get 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
  • giftCardID (path, required)
POST

/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
  • giftCardID (path, required)
GET

/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
  • giftCardID (path, required)
  • transactionID (path, required)
GET

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

Get Transaction Authorizations

  • 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
  • giftCardID (path, required)
  • transactionID (path, required)
GET

/giftcards/{giftCardID}/transactions/{transactionID}/cancellations

Get Transaction Cancellations

  • 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
  • giftCardID (path, required)
  • transactionID (path, required)
POST

/giftcards/{giftCardID}/transactions/{transactionID}/cancellations

Cancel 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
  • giftCardID (path, required)
  • transactionID (path, required)
GET

/giftcards/{giftCardID}/transactions/{transactionID}/settlements

Get Transaction Settlements

  • 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
  • giftCardID (path, required)
  • transactionID (path, required)
POST

/giftcards/{giftCardID}/transactions/{transactionID}/settlements

Settle 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
  • giftCardID (path, required)
  • transactionID (path, required)

11 endpoints auto-detected

Authentication

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

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

vtex.local · HTTPS only