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

url = "https://payments.sandbox.lerian.net/v1/dashboards/boletos"

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

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/dashboards/boletos")
.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/dashboards/boletos")

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
{
  "byStatus": {},
  "byType": {},
  "settlementRate": 123,
  "totalAmount": "<string>",
  "totalCanceled": 123,
  "totalFailed": 123,
  "totalInactivated": 123,
  "totalIssued": 123,
  "totalOverdue": 123,
  "totalOverdueAmount": "<string>",
  "totalPending": 123,
  "totalSettled": 123,
  "totalSettledAmount": "<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"
}

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 consulta

from
string

Created from date (YYYY-MM-DD)

to
string

Created to date (YYYY-MM-DD)

dueDateFrom
string

Due date from (YYYY-MM-DD)

dueDateTo
string

Due date to (YYYY-MM-DD)

type
enum<string>

Boleto type filter

Opções disponíveis:
TRADITIONAL,
HYBRID,
QR_CODE

Resposta

OK

byStatus
object
byType
object
settlementRate
number
totalAmount
string
totalCanceled
integer
totalFailed
integer
totalInactivated
integer
totalIssued
integer
totalOverdue
integer
totalOverdueAmount
string
totalPending
integer
totalSettled
integer
totalSettledAmount
string