Skip to main content
GET
/
api
/
v1
/
brcode
/
cob
List immediate charges
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cob \
  --header 'Authorization: Bearer <token>'
import requests

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

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

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

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

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
{
  "cobs": [
    {
      "calendario": {
        "criacao": "<string>",
        "expiracao": 123
      },
      "chave": "<string>",
      "loc": {
        "criacao": "<string>",
        "id": 123,
        "location": "<string>"
      },
      "location": "<string>",
      "pixCopiaECola": "<string>",
      "revisao": 123,
      "txid": "<string>",
      "valor": {
        "modalidadeAlteracao": 0,
        "original": "<string>",
        "retirada": {
          "saque": {
            "modalidadeAgente": "<string>",
            "prestadorDoServicoDeSaque": "<string>",
            "valor": "<string>",
            "modalidadeAlteracao": 0
          },
          "troco": {
            "modalidadeAgente": "<string>",
            "prestadorDoServicoDeSaque": "<string>",
            "valor": "<string>",
            "modalidadeAlteracao": 0
          }
        }
      },
      "devedor": {
        "cep": "<string>",
        "cidade": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>",
        "email": "<string>",
        "logradouro": "<string>",
        "nome": "<string>",
        "uf": "<string>"
      },
      "infoAdicionais": [
        {
          "nome": "<string>",
          "valor": "<string>"
        }
      ],
      "pix": [
        {
          "endToEndId": "<string>",
          "horario": "<string>",
          "valor": "<string>",
          "txid": "<string>"
        }
      ],
      "solicitacaoPagador": "<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"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

inicio
string

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

fim
string

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

cpf
string

Filtro pelo CPF do devedor.

Pattern: ^\d{11}$
cnpj
string

Filtro pelo CNPJ do devedor.

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

Filtro pela existência de location (true/false).

status
string

Filtro pelo status do registro da cobrança.

paginacao.paginaAtual
integer<int64>

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

Required range: x >= 0
paginacao.itensPorPagina
integer<int64>

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

Required range: 1 <= x <= 1000

Response

OK

cobs
object[] | null
required
parametros
object
required