Crear cobranza recurrente (txid generado por el PSP)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"valor": {
"original": "<string>"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
'import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
payload = {
"ajusteDiaUtil": True,
"calendario": { "dataDeVencimento": "<string>" },
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"valor": { "original": "<string>" },
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ajusteDiaUtil: true,
calendario: {dataDeVencimento: '<string>'},
idRec: '<string>',
recebedor: {conta: '<string>', agencia: '<string>'},
valor: {original: '<string>'},
devedor: {
cep: '<string>',
cidade: '<string>',
email: '<string>',
logradouro: '<string>',
uf: '<string>'
},
infoAdicional: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobr', 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/cobr",
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([
'ajusteDiaUtil' => true,
'calendario' => [
'dataDeVencimento' => '<string>'
],
'idRec' => '<string>',
'recebedor' => [
'conta' => '<string>',
'agencia' => '<string>'
],
'valor' => [
'original' => '<string>'
],
'devedor' => [
'cep' => '<string>',
'cidade' => '<string>',
'email' => '<string>',
'logradouro' => '<string>',
'uf' => '<string>'
],
'infoAdicional' => '<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/cobr"
payload := strings.NewReader("{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://spi.sandbox.lerian.net/api/v1/brcode/cobr")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobr")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"revisao": 123,
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atualizacao": [
{
"data": "<string>"
}
],
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "<string>",
"descricao": "<string>",
"solicitante": "<string>"
},
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
},
"infoAdicional": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Crear cobranza recurrente (txid generado por el PSP)
Crea una cobranza recurrente (CobR) con un txid generado por el servidor. API Pix POST /cobr.
POST
/
api
/
v1
/
brcode
/
cobr
Crear cobranza recurrente (txid generado por el PSP)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"valor": {
"original": "<string>"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
'import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
payload = {
"ajusteDiaUtil": True,
"calendario": { "dataDeVencimento": "<string>" },
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"valor": { "original": "<string>" },
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ajusteDiaUtil: true,
calendario: {dataDeVencimento: '<string>'},
idRec: '<string>',
recebedor: {conta: '<string>', agencia: '<string>'},
valor: {original: '<string>'},
devedor: {
cep: '<string>',
cidade: '<string>',
email: '<string>',
logradouro: '<string>',
uf: '<string>'
},
infoAdicional: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cobr', 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/cobr",
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([
'ajusteDiaUtil' => true,
'calendario' => [
'dataDeVencimento' => '<string>'
],
'idRec' => '<string>',
'recebedor' => [
'conta' => '<string>',
'agencia' => '<string>'
],
'valor' => [
'original' => '<string>'
],
'devedor' => [
'cep' => '<string>',
'cidade' => '<string>',
'email' => '<string>',
'logradouro' => '<string>',
'uf' => '<string>'
],
'infoAdicional' => '<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/cobr"
payload := strings.NewReader("{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://spi.sandbox.lerian.net/api/v1/brcode/cobr")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobr")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ajusteDiaUtil\": true,\n \"calendario\": {\n \"dataDeVencimento\": \"<string>\"\n },\n \"idRec\": \"<string>\",\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\"\n },\n \"valor\": {\n \"original\": \"<string>\"\n },\n \"devedor\": {\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicional\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"agencia": "<string>"
},
"revisao": 123,
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atualizacao": [
{
"data": "<string>"
}
],
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "<string>",
"descricao": "<string>",
"solicitante": "<string>"
},
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
},
"infoAdicional": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Idempotency key, max 255 characters.
Cuerpo
application/json
Ajusta a liquidação para o próximo dia útil quando o vencimento cai em dia não-útil.
Controle de tempo da cobrança.
Show child attributes
Show child attributes
Recorrência a que a cobrança pertence.
Pattern:
^[a-zA-Z0-9]{29}$Ejemplo:
"RR1234567820240115abcdefghijk"
Conta bancária do recebedor.
Show child attributes
Show child attributes
Valor da cobrança.
Show child attributes
Show child attributes
Contato do devedor (sem identidade; a identidade está na Rec).
Show child attributes
Show child attributes
Informação adicional (campo único, não array).
Maximum string length:
140Respuesta
Created
Show child attributes
Show child attributes
Pattern:
^[a-zA-Z0-9]{29}$Show child attributes
Show child attributes
Opciones disponibles:
CRIADA, ATIVA, CONCLUIDA, EXPIRADA, REJEITADA, CANCELADA Pattern:
^[a-zA-Z0-9]{26,35}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
140¿Esta página le ayudó?
⌘I