Payments Gateway API

vtex · Company

Company No Auth Free & Open API

>ℹ️ Onboarding guide > > Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). 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 the developer's journey. The Payments Gateway API allows you to get payment data and process your store's transactions.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Installments options

Returns the best installment options according to the informed params.

https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/installments?request.value=10&request.salesChannel=1&request.paymentDetails[0].id=2&request.paymentDetails[0].bin=411111&request.paymentDetails[0].value=10

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-PROVIDER-API-AppKey	{{X-PROVIDER-API-AppKey}}
X-PROVIDER-API-AppToken	{{X-PROVIDER-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/installments?request.value=10&request.salesChannel=1&request.paymentDetails[0].id=2&request.paymentDetails[0].bin=411111&request.paymentDetails[0].value=10" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}" \
  -H "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"

import requests
params = {
    "request.value": "10",
    "request.salesChannel": "1",
    "request.paymentDetails[0].id": "2",
    "request.paymentDetails[0].bin": "411111",
    "request.paymentDetails[0].value": "10"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-PROVIDER-API-AppKey": "{{X-PROVIDER-API-AppKey}}",
    "X-PROVIDER-API-AppToken": "{{X-PROVIDER-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/installments",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/installments');
url.searchParams.set('request.value', '10');
url.searchParams.set('request.salesChannel', '1');
url.searchParams.set('request.paymentDetails[0].id', '2');
url.searchParams.set('request.paymentDetails[0].bin', '411111');
url.searchParams.set('request.paymentDetails[0].value', '10');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-PROVIDER-API-AppKey': '{{X-PROVIDER-API-AppKey}}',
    'X-PROVIDER-API-AppToken': '{{X-PROVIDER-API-AppToken}}'
  },
}); 
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/Payments-Gateway-API/1.0/api/pvt/installments")
	q := baseURL.Query()
	q.Set("request.value", "10")
	q.Set("request.salesChannel", "1")
	q.Set("request.paymentDetails[0].id", "2")
	q.Set("request.paymentDetails[0].bin", "411111")
	q.Set("request.paymentDetails[0].value", "10")
	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")
	req.Header.Set("X-PROVIDER-API-AppKey", "{{X-PROVIDER-API-AppKey}}")
	req.Header.Set("X-PROVIDER-API-AppToken", "{{X-PROVIDER-API-AppToken}}")

	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/Payments-Gateway-API/1.0/api/pvt/installments")
uri.query = URI.encode_www_form({
  "request.value" => "10",
  "request.salesChannel" => "1",
  "request.paymentDetails[0].id" => "2",
  "request.paymentDetails[0].bin" => "411111",
  "request.paymentDetails[0].value" => "10"
})

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"
req["X-PROVIDER-API-AppKey"] = "{{X-PROVIDER-API-AppKey}}"
req["X-PROVIDER-API-AppToken"] = "{{X-PROVIDER-API-AppToken}}"

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/installments?" . http_build_query([
    "request.value" => "10",
    "request.salesChannel" => "1",
    "request.paymentDetails[0].id" => "2",
    "request.paymentDetails[0].bin" => "411111",
    "request.paymentDetails[0].value" => "10"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}",
        "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Affiliations

Returns all affiliations that your provider can handle.

https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/affiliations

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-PROVIDER-API-AppKey	{{X-PROVIDER-API-AppKey}}
X-PROVIDER-API-AppToken	{{X-PROVIDER-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/affiliations" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}" \
  -H "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-PROVIDER-API-AppKey": "{{X-PROVIDER-API-AppKey}}",
    "X-PROVIDER-API-AppToken": "{{X-PROVIDER-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/affiliations",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/affiliations';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-PROVIDER-API-AppKey': '{{X-PROVIDER-API-AppKey}}',
    'X-PROVIDER-API-AppToken': '{{X-PROVIDER-API-AppToken}}'
  },
}); 
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/Payments-Gateway-API/1.0/api/pvt/affiliations"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-PROVIDER-API-AppKey", "{{X-PROVIDER-API-AppKey}}")
	req.Header.Set("X-PROVIDER-API-AppToken", "{{X-PROVIDER-API-AppToken}}")

	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/Payments-Gateway-API/1.0/api/pvt/affiliations")

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"
req["X-PROVIDER-API-AppKey"] = "{{X-PROVIDER-API-AppKey}}"
req["X-PROVIDER-API-AppToken"] = "{{X-PROVIDER-API-AppToken}}"

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/affiliations";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}",
        "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Rules

Returns all rules conditions your provider can handle.

https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/rules

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json
X-PROVIDER-API-AppKey	{{X-PROVIDER-API-AppKey}}
X-PROVIDER-API-AppToken	{{X-PROVIDER-API-AppToken}}

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/rules" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}" \
  -H "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"

import requests
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "X-PROVIDER-API-AppKey": "{{X-PROVIDER-API-AppKey}}",
    "X-PROVIDER-API-AppToken": "{{X-PROVIDER-API-AppToken}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/rules",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/rules';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-PROVIDER-API-AppKey': '{{X-PROVIDER-API-AppKey}}',
    'X-PROVIDER-API-AppToken': '{{X-PROVIDER-API-AppToken}}'
  },
}); 
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/Payments-Gateway-API/1.0/api/pvt/rules"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-PROVIDER-API-AppKey", "{{X-PROVIDER-API-AppKey}}")
	req.Header.Set("X-PROVIDER-API-AppToken", "{{X-PROVIDER-API-AppToken}}")

	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/Payments-Gateway-API/1.0/api/pvt/rules")

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"
req["X-PROVIDER-API-AppKey"] = "{{X-PROVIDER-API-AppKey}}"
req["X-PROVIDER-API-AppToken"] = "{{X-PROVIDER-API-AppToken}}"

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Payments-Gateway-API/1.0/api/pvt/rules";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json",
        "X-PROVIDER-API-AppKey: {{X-PROVIDER-API-AppKey}}",
        "X-PROVIDER-API-AppToken: {{X-PROVIDER-API-AppToken}}"
    ]),
]];
$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 Payments Gateway API?

Payments Gateway 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. Payments Gateway 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 ↗