vtex.local

With Customer Credit your store can enable credit payments through the checkout. You can also control invoices and the credit limits of your clients. Learn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21l

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

Search all accounts

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

Search all invoices

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

Retrieve store configuration

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

Endpoints (26 total)

GET

/api/creditcontrol/accounts

Search all accounts

GET

/api/creditcontrol/invoices

Search all invoices

GET

/api/creditcontrol/storeconfig

Retrieve store configuration

GET

/api/creditcontrol/accounts/{creditAccountId}

Retrieve an Account by Id

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices

Retrieve invoice by creditAccountId

GET

/api/creditcontrol/accounts/{creditAccountId}/statements

Account statements

GET

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Retrieve Invoice by Id

POST

/api/creditcontrol/accounts

Open an Account

POST

/api/creditcontrol/accounts/{creditAccountId}/holders

Add an account Holder

POST

/api/creditcontrol/accounts/{creditAccountId}/transaction

Create a Pre Authorization

POST

/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments

Mark an invoice as Paid

POST

/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds

Partial or Total Refund a Settlement