Customer Credit API

vtex · Company

Company No Auth Free & Open API

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--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs). All requests need the **authorization header**. Additionally, you can find more information on installment payments for an order in the `customData` fiel

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Search all invoices

Returns all invoices according to the informed query params in the request.

https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices?to=&from=&value=101.22&status=Paid&friendlyId=insert identifier here&createdDateTo=&createdDateFrom=&creditAccountId=B75F0

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices?to=&from=&value=101.22&status=Paid&friendlyId=insert%20identifier%20here&createdDateTo=&createdDateFrom=&creditAccountId=B75F0" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "to": "",
    "from": "",
    "value": "101.22",
    "status": "Paid",
    "friendlyId": "insert identifier here",
    "createdDateTo": "",
    "createdDateFrom": "",
    "creditAccountId": "B75F0"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices');
url.searchParams.set('to', '');
url.searchParams.set('from', '');
url.searchParams.set('value', '101.22');
url.searchParams.set('status', 'Paid');
url.searchParams.set('friendlyId', 'insert identifier here');
url.searchParams.set('createdDateTo', '');
url.searchParams.set('createdDateFrom', '');
url.searchParams.set('creditAccountId', 'B75F0');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices")
	q := baseURL.Query()
	q.Set("to", "")
	q.Set("from", "")
	q.Set("value", "101.22")
	q.Set("status", "Paid")
	q.Set("friendlyId", "insert identifier here")
	q.Set("createdDateTo", "")
	q.Set("createdDateFrom", "")
	q.Set("creditAccountId", "B75F0")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices")
uri.query = URI.encode_www_form({
  "to" => "",
  "from" => "",
  "value" => "101.22",
  "status" => "Paid",
  "friendlyId" => "insert identifier here",
  "createdDateTo" => "",
  "createdDateFrom" => "",
  "creditAccountId" => "B75F0"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/invoices?" . http_build_query([
    "to" => "",
    "from" => "",
    "value" => "101.22",
    "status" => "Paid",
    "friendlyId" => "insert identifier here",
    "createdDateTo" => "",
    "createdDateFrom" => "",
    "creditAccountId" => "B75F0"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Search all accounts

Search all accounts

https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/accounts";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve store configuration

Get store configuration data.

https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Customer-Credit-API/1.0/api/creditcontrol/storeconfig";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Customer Credit API?

Customer Credit API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Customer Credit API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗