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

Rules

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

Affiliations

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

Installments options

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

Endpoints (22 total)

GET

/api/pvt/rules

Rules

GET

/api/pvt/affiliations

Affiliations

GET

/api/pvt/installments

Installments options

GET

/api/pvt/rules/{ruleId}

Rule By Id

GET

/api/pvt/merchants/payment-systems

Available Payment Methods

GET

/api/pvt/affiliations/{affiliationId}

Affiliation By Id

GET

/api/pvt/transactions/{transactionId}

Transaction Details

GET

/api/pvt/transactions/{transactionId}/settlements

Transaction Settlement Details

GET

/api/pvt/transactions/{transactionId}/payments/{paymentId}

Payment Details

POST

/api/pvt/rules

Insert Rule

POST

/api/pvt/affiliations

Insert Affiliation

POST

/api/pvt/transactions

1. Starts a new transaction