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

url = "https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{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/cobr/{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/cobr/{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/cobr/{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/cobr/{txid}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/cobr/{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
{
  "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>"
      }
    }
  ]
}
{
  "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 caminho

txid
string
obrigatório

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

Pattern: ^[a-zA-Z0-9]{26,35}$

Resposta

OK

ajusteDiaUtil
boolean
obrigatório
calendario
object
obrigatório
idRec
string
obrigatório
Pattern: ^[a-zA-Z0-9]{29}$
recebedor
object
obrigatório
revisao
integer<int64>
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
ATIVA,
CONCLUIDA,
EXPIRADA,
REJEITADA,
CANCELADA
txid
string
obrigatório
Pattern: ^[a-zA-Z0-9]{26,35}$
valor
object
obrigatório
atualizacao
object[] | null
devedor
object
encerramento
object
infoAdicional
string
Maximum string length: 140
tentativas
object[]

Histórico de tentativas de liquidação.