Pular para o conteúdo principal
GET
/
api
/
v1
/
brcode
/
rec
Consultar lista de recorrências (Pix Automático)
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
  --header 'Authorization: Bearer <token>'
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)
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));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://spi.sandbox.lerian.net/api/v1/brcode/rec",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
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))

}
HttpResponse<String> response = Unirest.get("https://spi.sandbox.lerian.net/api/v1/brcode/rec")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/rec")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "parametros": {
    "fim": "<string>",
    "inicio": "<string>",
    "paginacao": {
      "itensPorPagina": 123,
      "paginaAtual": 123,
      "quantidadeDePaginas": 123,
      "quantidadeTotalDeItens": 123
    }
  },
  "recs": [
    {
      "calendario": {
        "dataInicial": "<string>",
        "dataFinal": "<string>"
      },
      "idRec": "<string>",
      "recebedor": {
        "conta": "<string>",
        "agencia": "<string>",
        "convenio": "<string>"
      },
      "vinculo": {
        "contrato": "<string>",
        "devedor": {
          "cnpj": "<string>",
          "cpf": "<string>",
          "nome": "<string>"
        },
        "objeto": "<string>"
      },
      "atualizacao": [
        {
          "data": "<string>"
        }
      ],
      "solicitacao": [
        {
          "calendario": {
            "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
          },
          "destinatario": {
            "conta": "<string>",
            "ispbParticipante": "<string>",
            "agencia": "<string>",
            "cnpj": "<string>",
            "cpf": "<string>"
          },
          "idRec": "<string>",
          "idSolicRec": "<string>"
        }
      ],
      "valor": {
        "valorMinimoRecebedor": "<string>",
        "valorRec": "<string>"
      }
    }
  ]
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

inicio
string
obrigatório

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

fim
string
obrigatório

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

Intervalo obrigatório: x >= 0
paginacao.itensPorPagina
integer<int64>

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

Intervalo obrigatório: 1 <= x <= 1000

Resposta

OK

parametros
object
obrigatório
recs
object[] | null
obrigatório