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));

{
  "parametros": {
    "fim": "<string>",
    "inicio": "<string>",
    "paginacao": {
      "itensPorPagina": 123,
      "paginaAtual": 123,
      "quantidadeDePaginas": 123,
      "quantidadeTotalDeItens": 123
    }
  },
  "recs": [
    {
      "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"
}

GET

api

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));

{
  "parametros": {
    "fim": "<string>",
    "inicio": "<string>",
    "paginacao": {
      "itensPorPagina": 123,
      "paginaAtual": 123,
      "quantidadeDePaginas": 123,
      "quantidadeTotalDeItens": 123
    }
  },
  "recs": [
    {
      "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

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

inicio

string

requerido

Início do filtro de criação (RFC 3339).

fim

string

requerido

Fim do filtro de criação (RFC 3339).

cpf

string

Filtro pelo CPF do devedor. Mutuamente exclusivo com cnpj.

Pattern: ^\d{11}$

cnpj

string

Filtro pelo CNPJ do devedor. Mutuamente exclusivo com cpf.

Pattern: ^[0-9A-Z]{14}$

convenio

string

Filtro pelo convênio associado.

Maximum string length: 60

status

string

Filtro pelo status da recorrência.

paginacao.paginaAtual

integer<int64>

Página a ser retornada (0-based).

Rango requerido: x >= 0

paginacao.itensPorPagina

integer<int64>

Itens por página (1..1000).

Rango requerido: 1 <= x <= 1000

Respuesta

parametros

object

requerido

Show child attributes

recs

object[] | null

requerido

Show child attributes