Create due-date charge (idempotent txid)
curl --request PUT \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendario": {
"dataDeVencimento": "<string>",
"validadeAposVencimento": 1
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"valor": {
"original": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"id": 123
},
"solicitacaoPagador": "<string>"
}
'import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"
payload = {
"calendario": {
"dataDeVencimento": "<string>",
"validadeAposVencimento": 1
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"valor": { "original": "<string>" },
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": { "id": 123 },
"solicitacaoPagador": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
calendario: {dataDeVencimento: '<string>', validadeAposVencimento: 1},
chave: '<string>',
devedor: {
cep: '<string>',
cidade: '<string>',
cnpj: '<string>',
cpf: '<string>',
email: '<string>',
logradouro: '<string>',
nome: '<string>',
uf: '<string>'
},
valor: {original: '<string>'},
infoAdicionais: [{nome: '<string>', valor: '<string>'}],
loc: {id: 123},
solicitacaoPagador: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}', 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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}",
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([
'calendario' => [
'dataDeVencimento' => '<string>',
'validadeAposVencimento' => 1
],
'chave' => '<string>',
'devedor' => [
'cep' => '<string>',
'cidade' => '<string>',
'cnpj' => '<string>',
'cpf' => '<string>',
'email' => '<string>',
'logradouro' => '<string>',
'nome' => '<string>',
'uf' => '<string>'
],
'valor' => [
'original' => '<string>'
],
'infoAdicionais' => [
[
'nome' => '<string>',
'valor' => '<string>'
]
],
'loc' => [
'id' => 123
],
'solicitacaoPagador' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"
payload := strings.NewReader("{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"calendario": {
"criacao": "<string>",
"dataDeVencimento": "<string>",
"validadeAposVencimento": 123
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>"
},
"location": "<string>",
"pixCopiaECola": "<string>",
"recebedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"nomeFantasia": "<string>",
"uf": "<string>"
},
"revisao": 123,
"txid": "<string>",
"valor": {
"abatimento": {
"modalidade": 123,
"valorPerc": "<string>"
},
"desconto": {
"modalidade": 3,
"descontoDataFixa": [
{
"data": "<string>",
"valorPerc": "<string>"
}
],
"valorPerc": "<string>"
},
"juros": {
"modalidade": 123,
"valorPerc": "<string>"
},
"multa": {
"modalidade": 123,
"valorPerc": "<string>"
},
"original": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"solicitacaoPagador": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Create due-date charge (idempotent txid)
Prerequisite: create this charge before generating its QR/payload (see generateBRCode and resolveCobVPayload). Creates a due-date charge (CobV) identified by the path txid (idempotent). Pix API v2.9 PUT /cobv/.
PUT
/
api
/
v1
/
brcode
/
cobv
/
{txid}
Create due-date charge (idempotent txid)
curl --request PUT \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendario": {
"dataDeVencimento": "<string>",
"validadeAposVencimento": 1
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"valor": {
"original": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"id": 123
},
"solicitacaoPagador": "<string>"
}
'import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"
payload = {
"calendario": {
"dataDeVencimento": "<string>",
"validadeAposVencimento": 1
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"valor": { "original": "<string>" },
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": { "id": 123 },
"solicitacaoPagador": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
calendario: {dataDeVencimento: '<string>', validadeAposVencimento: 1},
chave: '<string>',
devedor: {
cep: '<string>',
cidade: '<string>',
cnpj: '<string>',
cpf: '<string>',
email: '<string>',
logradouro: '<string>',
nome: '<string>',
uf: '<string>'
},
valor: {original: '<string>'},
infoAdicionais: [{nome: '<string>', valor: '<string>'}],
loc: {id: 123},
solicitacaoPagador: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}', 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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}",
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([
'calendario' => [
'dataDeVencimento' => '<string>',
'validadeAposVencimento' => 1
],
'chave' => '<string>',
'devedor' => [
'cep' => '<string>',
'cidade' => '<string>',
'cnpj' => '<string>',
'cpf' => '<string>',
'email' => '<string>',
'logradouro' => '<string>',
'nome' => '<string>',
'uf' => '<string>'
],
'valor' => [
'original' => '<string>'
],
'infoAdicionais' => [
[
'nome' => '<string>',
'valor' => '<string>'
]
],
'loc' => [
'id' => 123
],
'solicitacaoPagador' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"
payload := strings.NewReader("{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\",\n \"validadeAposVencimento\": 1\n },\n \"chave\": \"<string>\",\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"nome\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 123\n },\n \"solicitacaoPagador\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"calendario": {
"criacao": "<string>",
"dataDeVencimento": "<string>",
"validadeAposVencimento": 123
},
"chave": "<string>",
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"email": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"uf": "<string>"
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>"
},
"location": "<string>",
"pixCopiaECola": "<string>",
"recebedor": {
"cep": "<string>",
"cidade": "<string>",
"cnpj": "<string>",
"cpf": "<string>",
"logradouro": "<string>",
"nome": "<string>",
"nomeFantasia": "<string>",
"uf": "<string>"
},
"revisao": 123,
"txid": "<string>",
"valor": {
"abatimento": {
"modalidade": 123,
"valorPerc": "<string>"
},
"desconto": {
"modalidade": 3,
"descontoDataFixa": [
{
"data": "<string>",
"valorPerc": "<string>"
}
],
"valorPerc": "<string>"
},
"juros": {
"modalidade": 123,
"valorPerc": "<string>"
},
"multa": {
"modalidade": 123,
"valorPerc": "<string>"
},
"original": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"solicitacaoPagador": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key, max 255 characters.
Path Parameters
Identificador da transação [a-zA-Z0-9]{26,35}.
Body
application/json
Controle de tempo da cobrança.
Show child attributes
Show child attributes
Chave DICT do recebedor.
Maximum string length:
77Example:
"pix@lerian.studio"
Devedor da cobrança (PF/PJ). Obrigatório em CobV.
Show child attributes
Show child attributes
Valores monetários da cobrança.
Show child attributes
Show child attributes
Informações adicionais (máx 50).
Show child attributes
Show child attributes
Referência de location.
Show child attributes
Show child attributes
Texto livre apresentado ao pagador.
Maximum string length:
140Response
Created
Show child attributes
Show child attributes
Chave DICT do recebedor.
Maximum string length:
77Show child attributes
Show child attributes
Show child attributes
Show child attributes
Localização do payload.
Maximum string length:
77Pix Copia e Cola (BR Code) correspondente à cobrança.
Maximum string length:
512Show child attributes
Show child attributes
Revisão da cobrança (inicia em 0).
Status do registro da cobrança.
Available options:
ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP Identificador da transação.
Pattern:
[a-zA-Z0-9]{26,35}Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
140Was this page helpful?
⌘I