Marcar cobrança como paga (manual)
curl --request PUT \
--url https://sandbox.api.veepag.com/v1/charge/paid \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"companyId": "<string>",
"_id": "<string>"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/charge/paid"
payload = {
"companyId": "<string>",
"_id": "<string>"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({companyId: '<string>', _id: '<string>'})
};
fetch('https://sandbox.api.veepag.com/v1/charge/paid', 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/paid",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => '<string>',
'_id' => '<string>'
]),
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/paid"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.api.veepag.com/v1/charge/paid")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/charge/paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "charge_id",
"status": "PAID"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/charge/paid",
"metadata": {}
}Charge
Marcar cobrança como paga (manual)
Marca uma cobranca como paga. A operacao e idempotente se a cobranca ja estiver PAID.
PUT
/
v1
/
charge
/
paid
Marcar cobrança como paga (manual)
curl --request PUT \
--url https://sandbox.api.veepag.com/v1/charge/paid \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"companyId": "<string>",
"_id": "<string>"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/charge/paid"
payload = {
"companyId": "<string>",
"_id": "<string>"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({companyId: '<string>', _id: '<string>'})
};
fetch('https://sandbox.api.veepag.com/v1/charge/paid', 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/paid",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => '<string>',
'_id' => '<string>'
]),
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/paid"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.api.veepag.com/v1/charge/paid")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/charge/paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "charge_id",
"status": "PAID"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/charge/paid",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/charge/paid",
"metadata": {}
}Authorizations
api_keytoken
API key no formato keyId.secret.
Body
application/json
Response
Cobranca marcada como paga.
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.
Available options:
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.
Available options:
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?
