List recurrences (Pix Automático)
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"parametros": {
"fim": "<string>",
"inicio": "<string>",
"paginacao": {
"itensPorPagina": 123,
"paginaAtual": 123,
"quantidadeDePaginas": 123,
"quantidadeTotalDeItens": 123
}
},
"recs": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "12ABC34501DE35",
"conta": "1234567890",
"nome": "Empresa Recebedora LTDA",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>",
"ispbParticipante": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"ativacao": {
"tipoJornada": "JORNADA_1",
"dadosJornada": {
"txid": "<string>"
}
},
"encerramento": {
"cancelamento": {
"codigo": "ACCL",
"descricao": "<string>",
"solicitante": "PSP_PAGADOR"
},
"rejeicao": {
"codigo": "AP13",
"descricao": "<string>"
}
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>",
"tipo": "rec",
"idRec": "<string>"
},
"pagador": {
"cnpj": "28333333150443",
"codMun": "3550308",
"cpf": "23933333316",
"ispbParticipante": "81102623"
},
"solicitacao": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA",
"recPayload": {
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "<string>",
"ispbParticipante": "<string>",
"nome": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
]
}{
"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"
}
}List recurrences (Pix Automático)
Lists recurrences by start date, end date, cpf, cnpj, convênio, and status. Pix API GET /rec.
GET
/
api
/
v1
/
brcode
/
rec
List recurrences (Pix Automático)
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"parametros": {
"fim": "<string>",
"inicio": "<string>",
"paginacao": {
"itensPorPagina": 123,
"paginaAtual": 123,
"quantidadeDePaginas": 123,
"quantidadeTotalDeItens": 123
}
},
"recs": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "12ABC34501DE35",
"conta": "1234567890",
"nome": "Empresa Recebedora LTDA",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>",
"ispbParticipante": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"ativacao": {
"tipoJornada": "JORNADA_1",
"dadosJornada": {
"txid": "<string>"
}
},
"encerramento": {
"cancelamento": {
"codigo": "ACCL",
"descricao": "<string>",
"solicitante": "PSP_PAGADOR"
},
"rejeicao": {
"codigo": "AP13",
"descricao": "<string>"
}
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>",
"tipo": "rec",
"idRec": "<string>"
},
"pagador": {
"cnpj": "28333333150443",
"codMun": "3550308",
"cpf": "23933333316",
"ispbParticipante": "81102623"
},
"solicitacao": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA",
"recPayload": {
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "<string>",
"ispbParticipante": "<string>",
"nome": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
]
}{
"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"
}
}Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de consulta
Início do filtro de criação (RFC 3339).
Fim do filtro de criação (RFC 3339).
Filtro pelo CPF do devedor. Mutuamente exclusivo com cnpj.
Pattern:
^\d{11}$Filtro pelo CNPJ do devedor. Mutuamente exclusivo com cpf.
Pattern:
^[0-9A-Z]{14}$Filtro pelo convênio associado.
Maximum string length:
60Filtro pelo status da recorrência.
Página a ser retornada (0-based).
Intervalo obrigatório:
x >= 0Itens por página (1..1000).
Intervalo obrigatório:
1 <= x <= 1000Esta página foi útil?

