Create recurrence (Pix Automático)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"politicaRetentativa": "PERMITE_3R_7D",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec"
payload := strings.NewReader("{\n \"calendario\": {\n \"dataInicial\": \"2025-07-15\",\n \"periodicidade\": \"MENSAL\",\n \"dataFinal\": \"<string>\"\n },\n \"politicaRetentativa\": \"PERMITE_3R_7D\",\n \"recebedor\": {\n \"conta\": \"1234567890\",\n \"tipoConta\": \"CORRENTE\",\n \"agencia\": \"0001\",\n \"convenio\": \"<string>\"\n },\n \"vinculo\": {\n \"contrato\": \"contrato-12345\",\n \"devedor\": {\n \"cnpj\": \"12ABC34501DE35\",\n \"cpf\": \"12345678901\",\n \"nome\": \"Fulano de Tal\"\n },\n \"objeto\": \"<string>\"\n },\n \"valor\": {\n \"valorMinimoRecebedor\": \"<string>\",\n \"valorRec\": \"99.90\"\n }\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))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
calendario: {dataInicial: '2025-07-15', periodicidade: 'MENSAL', dataFinal: '<string>'},
politicaRetentativa: 'PERMITE_3R_7D',
recebedor: {
conta: '1234567890',
tipoConta: 'CORRENTE',
agencia: '0001',
convenio: '<string>'
},
vinculo: {
contrato: 'contrato-12345',
devedor: {cnpj: '12ABC34501DE35', cpf: '12345678901', nome: 'Fulano de Tal'},
objeto: '<string>'
},
valor: {valorMinimoRecebedor: '<string>', valorRec: '99.90'}
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec', 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/rec"
payload = {
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"politicaRetentativa": "PERMITE_3R_7D",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"solicitacao": [
{
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA"
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}{
"code": "ERR-0001",
"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"
}Create recurrence (Pix Automático)
Creates a recebedor-side recurrence (Rec) with a server-generated idRec. Pix API POST /rec.
POST
/
api
/
v1
/
brcode
/
rec
Create recurrence (Pix Automático)
curl --request POST \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"politicaRetentativa": "PERMITE_3R_7D",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec"
payload := strings.NewReader("{\n \"calendario\": {\n \"dataInicial\": \"2025-07-15\",\n \"periodicidade\": \"MENSAL\",\n \"dataFinal\": \"<string>\"\n },\n \"politicaRetentativa\": \"PERMITE_3R_7D\",\n \"recebedor\": {\n \"conta\": \"1234567890\",\n \"tipoConta\": \"CORRENTE\",\n \"agencia\": \"0001\",\n \"convenio\": \"<string>\"\n },\n \"vinculo\": {\n \"contrato\": \"contrato-12345\",\n \"devedor\": {\n \"cnpj\": \"12ABC34501DE35\",\n \"cpf\": \"12345678901\",\n \"nome\": \"Fulano de Tal\"\n },\n \"objeto\": \"<string>\"\n },\n \"valor\": {\n \"valorMinimoRecebedor\": \"<string>\",\n \"valorRec\": \"99.90\"\n }\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))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
calendario: {dataInicial: '2025-07-15', periodicidade: 'MENSAL', dataFinal: '<string>'},
politicaRetentativa: 'PERMITE_3R_7D',
recebedor: {
conta: '1234567890',
tipoConta: 'CORRENTE',
agencia: '0001',
convenio: '<string>'
},
vinculo: {
contrato: 'contrato-12345',
devedor: {cnpj: '12ABC34501DE35', cpf: '12345678901', nome: 'Fulano de Tal'},
objeto: '<string>'
},
valor: {valorMinimoRecebedor: '<string>', valorRec: '99.90'}
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec', 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/rec"
payload = {
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"politicaRetentativa": "PERMITE_3R_7D",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"calendario": {
"dataInicial": "2025-07-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"conta": "1234567890",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"solicitacao": [
{
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA"
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}{
"code": "ERR-0001",
"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"
}Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Idempotency key, max 255 characters.
Cuerpo
application/json
Cadência da recorrência.
Show child attributes
Show child attributes
Política de retentativa.
Opciones disponibles:
NAO_PERMITE, PERMITE_3R_7D Ejemplo:
"PERMITE_3R_7D"
Conta bancária do recebedor.
Show child attributes
Show child attributes
Vínculo (contrato + devedor).
Show child attributes
Show child attributes
Valor da recorrência (opcional; fixo ou piso).
Show child attributes
Show child attributes
Respuesta
Created
Show child attributes
Show child attributes
Identificador da recorrência.
Pattern:
^[a-zA-Z0-9]{29}$Opciones disponibles:
NAO_PERMITE, PERMITE_3R_7D Show child attributes
Show child attributes
Opciones disponibles:
CRIADA, APROVADA, REJEITADA, EXPIRADA, CANCELADA Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
¿Esta página le ayudó?