Create recurring charge (PSP-generated txid)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "2025-08-15"
},
"idRec": "RR1234567820240115abcdefghijk",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001"
},
"valor": {
"original": "100.00"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
'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\": \"2025-08-15\"\n },\n \"idRec\": \"RR1234567820240115abcdefghijk\",\n \"recebedor\": {\n \"conta\": \"1234567890\",\n \"tipoConta\": \"CORRENTE\",\n \"agencia\": \"0001\"\n },\n \"valor\": {\n \"original\": \"100.00\"\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("X-Idempotency", "<x-idempotency>")
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))
}const options = {
method: 'POST',
headers: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ajusteDiaUtil: true,
calendario: {dataDeVencimento: '2025-08-15'},
idRec: 'RR1234567820240115abcdefghijk',
recebedor: {conta: '1234567890', tipoConta: 'CORRENTE', agencia: '0001'},
valor: {original: '100.00'},
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));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
payload = {
"ajusteDiaUtil": True,
"calendario": { "dataDeVencimento": "2025-08-15" },
"idRec": "RR1234567820240115abcdefghijk",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001"
},
"valor": { "original": "100.00" },
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"tipoConta": "CORRENTE",
"agencia": "<string>"
},
"revisao": 123,
"status": "CRIADA",
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"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>"
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Create recurring charge (PSP-generated txid)
Creates a recurring charge (CobR) with a server-generated txid. Pix API POST /cobr.
POST
/
api
/
v1
/
brcode
/
cobr
Create recurring charge (PSP-generated txid)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "2025-08-15"
},
"idRec": "RR1234567820240115abcdefghijk",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001"
},
"valor": {
"original": "100.00"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
'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\": \"2025-08-15\"\n },\n \"idRec\": \"RR1234567820240115abcdefghijk\",\n \"recebedor\": {\n \"conta\": \"1234567890\",\n \"tipoConta\": \"CORRENTE\",\n \"agencia\": \"0001\"\n },\n \"valor\": {\n \"original\": \"100.00\"\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("X-Idempotency", "<x-idempotency>")
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))
}const options = {
method: 'POST',
headers: {
'X-Idempotency': '<x-idempotency>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ajusteDiaUtil: true,
calendario: {dataDeVencimento: '2025-08-15'},
idRec: 'RR1234567820240115abcdefghijk',
recebedor: {conta: '1234567890', tipoConta: 'CORRENTE', agencia: '0001'},
valor: {original: '100.00'},
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));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
payload = {
"ajusteDiaUtil": True,
"calendario": { "dataDeVencimento": "2025-08-15" },
"idRec": "RR1234567820240115abcdefghijk",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001"
},
"valor": { "original": "100.00" },
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicional": "<string>"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ajusteDiaUtil": true,
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"recebedor": {
"conta": "<string>",
"tipoConta": "CORRENTE",
"agencia": "<string>"
},
"revisao": 123,
"status": "CRIADA",
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"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>"
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}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
Atestação de titularidade da conta do recebedor (obrigatória quando a conta difere da conta da recorrência).
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
Show child attributes
Show child attributes
Maximum string length:
140¿Esta página le ayudó?