Pular para o conteúdo principal
GET
/
v1
/
boletos
/
{id}
Obter um boleto por ID
curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/boletos/{id} \
  --header 'Authorization: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
import requests

url = "https://payments.sandbox.lerian.net/v1/boletos/{id}"

headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'X-Organization-Id': '<x-organization-id>', Authorization: '<api-key>'}
};

fetch('https://payments.sandbox.lerian.net/v1/boletos/{id}', 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://payments.sandbox.lerian.net/v1/boletos/{id}",
  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: <api-key>",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$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://payments.sandbox.lerian.net/v1/boletos/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://payments.sandbox.lerian.net/v1/boletos/{id}")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://payments.sandbox.lerian.net/v1/boletos/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "amount": "<string>",
  "barcode": "<string>",
  "canceledAt": "<string>",
  "cancellationReason": "<string>",
  "createdAt": "<string>",
  "digitableLine": "<string>",
  "discount": {
    "amount": "<string>",
    "limitDate": "<string>",
    "type": "<string>"
  },
  "dueDate": "<string>",
  "errorMessage": "<string>",
  "failedAt": "<string>",
  "fine": {
    "amount": "<string>",
    "type": "<string>"
  },
  "guarantor": {
    "address": {
      "city": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "number": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipCode": "<string>"
    },
    "document": "<string>",
    "name": "<string>"
  },
  "id": "<string>",
  "inactivatedAt": "<string>",
  "installmentLabel": "<string>",
  "instructions": "<string>",
  "interest": {
    "amount": "<string>",
    "type": "<string>"
  },
  "kind": "<string>",
  "payer": {
    "address": {
      "city": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "number": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipCode": "<string>"
    },
    "document": "<string>",
    "name": "<string>"
  },
  "providerId": "<string>",
  "qrCode": "<string>",
  "seriesId": "<string>",
  "settledAmount": "<string>",
  "settledAt": "<string>",
  "status": "<string>",
  "type": "<string>",
  "updatedAt": "<string>"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}
{
  "code": "PBP-0001",
  "details": {},
  "message": "dueDate must be in YYYY-MM-DD format",
  "title": "Bad Request"
}

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

X-Organization-Id
string
obrigatório

Tenant organization ID

Parâmetros de caminho

id
string
obrigatório

Boleto ID (UUID)

Resposta

OK

amount
string
barcode
string
canceledAt
string
cancellationReason
string
createdAt
string
digitableLine
string
discount
object
dueDate
string
errorMessage
string
failedAt
string
fine
object
guarantor
object
id
string
inactivatedAt
string
installmentLabel
string
instructions
string
interest
object
kind
string
payer
object
providerId
string
qrCode
string
seriesId
string
settledAmount
string
settledAt
string
status
string
type
string
updatedAt
string