Skip to main content
GET
/
api
/
v1
/
brcode
/
cobv
/
{txid}
Retrieve due-date charge
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}"

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/cobv/{txid}', 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/cobv/{txid}",
  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/cobv/{txid}"

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

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid}")

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
{
  "calendario": {
    "criacao": "<string>",
    "dataDeVencimento": "<string>",
    "validadeAposVencimento": 123
  },
  "chave": "<string>",
  "devedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "email": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "uf": "<string>"
  },
  "loc": {
    "criacao": "<string>",
    "id": 123,
    "location": "<string>"
  },
  "location": "<string>",
  "pixCopiaECola": "<string>",
  "recebedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "nomeFantasia": "<string>",
    "uf": "<string>"
  },
  "revisao": 123,
  "txid": "<string>",
  "valor": {
    "abatimento": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "desconto": {
      "modalidade": 3,
      "descontoDataFixa": [
        {
          "data": "<string>",
          "valorPerc": "<string>"
        }
      ],
      "valorPerc": "<string>"
    },
    "juros": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "multa": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "original": "<string>"
  },
  "infoAdicionais": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ],
  "pix": [
    {
      "endToEndId": "<string>",
      "horario": "<string>",
      "valor": "<string>",
      "txid": "<string>"
    }
  ],
  "solicitacaoPagador": "<string>"
}
{
  "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.

Path Parameters

txid
string
required

Identificador da transação [a-zA-Z0-9]{26,35}.

Response

OK

calendario
object
required
chave
string
required

Chave DICT do recebedor.

Maximum string length: 77
devedor
object
required
loc
object
required
location
string
required

Localização do payload.

Maximum string length: 77
pixCopiaECola
string
required

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512
recebedor
object
required
revisao
integer<int64>
required

Revisão da cobrança (inicia em 0).

status
enum<string>
required

Status do registro da cobrança.

Available options:
ATIVA,
CONCLUIDA,
REMOVIDA_PELO_USUARIO_RECEBEDOR,
REMOVIDA_PELO_PSP
txid
string
required

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}
valor
object
required
infoAdicionais
object[] | null
pix
object[] | null

Pix recebidos vinculados à cobrança.

solicitacaoPagador
string
Maximum string length: 140