curl --request POST \
--url https://sandbox.api.veepag.com/v1/charge \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"companyId": "company_id",
"clientId": "client_id",
"productId": "product_id",
"dueDate": "2026-07-23",
"amount": 99.9,
"description": "Mensalidade julho"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/charge"
payload = {
"companyId": "company_id",
"clientId": "client_id",
"productId": "product_id",
"dueDate": "2026-07-23",
"amount": 99.9,
"description": "Mensalidade julho"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: 'company_id',
clientId: 'client_id',
productId: 'product_id',
dueDate: '2026-07-23',
amount: 99.9,
description: 'Mensalidade julho'
})
};
fetch('https://sandbox.api.veepag.com/v1/charge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.veepag.com/v1/charge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'company_id',
'clientId' => 'client_id',
'productId' => 'product_id',
'dueDate' => '2026-07-23',
'amount' => 99.9,
'description' => 'Mensalidade julho'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.veepag.com/v1/charge"
payload := strings.NewReader("{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.veepag.com/v1/charge")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/charge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "charge_id",
"companyId": "company_id",
"amount": 9990,
"status": "ACTIVE"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/charge",
"metadata": {}
}Create a new charge
Cria uma cobranca para um cliente e produto. O amount e convertido para centavos internamente.
curl --request POST \
--url https://sandbox.api.veepag.com/v1/charge \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"companyId": "company_id",
"clientId": "client_id",
"productId": "product_id",
"dueDate": "2026-07-23",
"amount": 99.9,
"description": "Mensalidade julho"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/charge"
payload = {
"companyId": "company_id",
"clientId": "client_id",
"productId": "product_id",
"dueDate": "2026-07-23",
"amount": 99.9,
"description": "Mensalidade julho"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: 'company_id',
clientId: 'client_id',
productId: 'product_id',
dueDate: '2026-07-23',
amount: 99.9,
description: 'Mensalidade julho'
})
};
fetch('https://sandbox.api.veepag.com/v1/charge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.veepag.com/v1/charge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => 'company_id',
'clientId' => 'client_id',
'productId' => 'product_id',
'dueDate' => '2026-07-23',
'amount' => 99.9,
'description' => 'Mensalidade julho'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.veepag.com/v1/charge"
payload := strings.NewReader("{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.veepag.com/v1/charge")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/charge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"company_id\",\n \"clientId\": \"client_id\",\n \"productId\": \"product_id\",\n \"dueDate\": \"2026-07-23\",\n \"amount\": 99.9,\n \"description\": \"Mensalidade julho\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "charge_id",
"companyId": "company_id",
"amount": 9990,
"status": "ACTIVE"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/charge",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/charge",
"metadata": {}
}Authorizations
API key no formato keyId.secret.
Body
ID da empresa da cobranca.
ID do cliente que recebera a cobranca.
ID do produto vinculado a cobranca.
Data de vencimento da cobranca.
Valor decimal da cobranca. O backend converte internamente para centavos com Math.round(amount * 100).
Opcoes de pagamento disponiveis para a cobranca.
Show child attributes
Show child attributes
Descricao da cobranca.
Indica uso de autorizacao de cartao, quando aplicavel.
Response
Cobranca criada.
ID da cobranca.
ID da empresa vinculada a cobranca.
ID do cliente vinculado.
ID do produto vinculado.
ID da assinatura vinculada, quando houver.
Valor da cobranca, normalmente com value em centavos e currency BRL.
Data de vencimento da cobranca.
Descricao da cobranca.
Status atual da cobranca.
PAID, ACTIVE, ANTICIPATED, CANCELED, CANCELED_ALERT_ETHOCA, PENDING_PAYMENT, IMPORTED, ERROR_PAYMENT, ERROR_REFUNDED, OVERDUE, NO_PAYMENT_ROUTE, RECOVERED, BLOCKED, NO_PAYMENT, CANCELED_MANUAL, DISPUTE, CHARGEBACK, STANDBY, DISABLED Metodos de pagamento disponiveis.
CREDIT_CARD, DEBIT_CARD, BOLETO, PIX Opcoes de pagamento da cobranca.
Indica se a cobranca esta ativa.
Numero sequencial da cobranca, quando houver.
Data de criacao da cobranca.
Data da ultima atualizacao da cobranca.
Was this page helpful?
