vtex.local

>ℹ️ Onboarding guide > > 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 b

🔑 apikey 11 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get GiftCard by ID

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/giftcards/{giftCardID}

Get GiftCard Transactions

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/giftcards/{giftCardID}/transactions

Get GiftCard Transaction by ID

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/giftcards/{giftCardID}/transactions/{transactionID}

Endpoints (11 total)

GET

/giftcards/{giftCardID}

Get GiftCard by ID

GET

/giftcards/{giftCardID}/transactions

Get GiftCard Transactions

GET

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

Get GiftCard Transaction by ID

GET

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

Get Transaction Settlements

GET

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

Get Transaction Authorizations

GET

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

Get Transaction Cancellations

POST

/giftcards

Create GiftCard

POST

/giftcards/_search

Get GiftCard using JSON

POST

/giftcards/{giftCardID}/transactions

Create GiftCard Transaction

POST

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

Settle GiftCard Transaction

POST

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

Cancel GiftCard Transaction