List boletos
curl --request GET \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: <api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://payments.sandbox.lerian.net/v1/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/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/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/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/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/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{
"items": [
{
"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>"
}
],
"limit": 123,
"page": 123,
"total": 123
}{
"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"
}List boletos
Lists boletos with optional filters for status, type, kind, dates, and pagination.
GET
/
v1
/
boletos
List boletos
curl --request GET \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: <api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://payments.sandbox.lerian.net/v1/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/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/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/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/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/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{
"items": [
{
"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>"
}
],
"limit": 123,
"page": 123,
"total": 123
}{
"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"
}Authorizations
Bearer token authentication (format: "Bearer {token}")
Headers
Tenant organization ID
Query Parameters
Page number (default: 1)
Items per page (default: 20, max: 100)
Status filter
Available options:
PENDING, CREATED, SETTLED, CANCELED, INACTIVATED, FAILED Boleto type filter
Available options:
TRADITIONAL, QR_CODE, HYBRID Boleto kind filter
Available options:
SINGLE, INSTALLMENT Created from date (YYYY-MM-DD)
Created to date (YYYY-MM-DD)
Due date from (YYYY-MM-DD)
Due date to (YYYY-MM-DD)
Was this page helpful?
⌘I