vtex.local

>ℹ️ 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 th

🔑 apikey 15 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

List All GiftCard Providers

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

Get GiftCard Provider by ID

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

Get GiftCard from GiftCard Provider by ID

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

Endpoints (15 total)

GET

/giftcardproviders

List All GiftCard Providers

GET

/giftcardproviders/{giftCardProviderId}

Get GiftCard Provider by ID

GET

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

Get GiftCard from GiftCard Provider by ID

GET

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

List All GiftCard Transactions

GET

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

Get GiftCard Transaction by ID

GET

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

List All GiftCard Settlement Transactions

GET

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

List All GiftCard Cancellation Transactions

GET

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

Get GiftCard Authorization Transaction

POST

/giftcardproviders/{giftCardProviderID}/giftcards

Create GiftCard in GiftCard Provider

POST

/giftcardproviders/{giftCardProviderID}/giftcards/_search

Get GiftCard from GiftCard Provider

POST

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

Create GiftCard Transaction

POST

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

Create GiftCard Settlement Transaction