Pular para o conteúdo principal
GET
/
api
/
v1
/
brcode
/
cobr
Consultar lista de cobranças recorrentes
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"

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/cobr', 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/cobr",
  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/cobr"

	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/cobr")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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
{
  "cobsr": [
    {
      "ajusteDiaUtil": true,
      "calendario": {
        "dataDeVencimento": "<string>",
        "criacao": "<string>"
      },
      "idRec": "<string>",
      "recebedor": {
        "conta": "<string>",
        "agencia": "<string>"
      },
      "revisao": 123,
      "txid": "<string>",
      "valor": {
        "original": "<string>"
      },
      "atualizacao": [
        {
          "data": "<string>"
        }
      ],
      "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>",
      "tentativas": [
        {
          "dataLiquidacao": "<string>",
          "endToEndId": "<string>",
          "atualizacao": [
            {
              "data": "<string>"
            }
          ],
          "rejeicao": {
            "codigo": "<string>",
            "descricao": "<string>"
          }
        }
      ]
    }
  ],
  "parametros": {
    "fim": "<string>",
    "inicio": "<string>",
    "paginacao": {
      "itensPorPagina": 123,
      "paginaAtual": 123,
      "quantidadeDePaginas": 123,
      "quantidadeTotalDeItens": 123
    }
  }
}
{
  "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

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

fim
string

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

idRec
string

Filtro pela recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
status
string

Filtro pelo status da cobrança recorrente.

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

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