List boletos
curl --request GET \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: Bearer <token>'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("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://payments.sandbox.lerian.net/v1/boletos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://payments.sandbox.lerian.net/v1/boletos"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"amount": "<string>",
"cancelable": true,
"createdAt": "<string>",
"dueDate": "<string>",
"id": "<string>",
"kind": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"status": "<string>",
"type": "<string>",
"updatedAt": "<string>",
"barcode": "<string>",
"canceledAt": "<string>",
"cancellationReason": "<string>",
"digitableLine": "<string>",
"discount": {
"amount": "<string>",
"limitDate": "<string>",
"type": "<string>"
},
"errorMessage": "<string>",
"failedAt": "<string>",
"fine": {
"amount": "<string>",
"type": "<string>"
},
"guarantor": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"inactivatedAt": "<string>",
"installmentLabel": "<string>",
"instructions": "<string>",
"interest": {
"amount": "<string>",
"type": "<string>"
},
"midazOperationId": "<string>",
"providerId": "<string>",
"qrCode": "<string>",
"seriesId": "<string>",
"settledAmount": "<string>",
"settledAt": "<string>"
}
],
"limit": 123,
"page": 123,
"total": 123
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}"<string>"{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}List boletos
Lists boletos with optional status, kind, type and date filters, paginated.
GET
/
v1
/
boletos
List boletos
curl --request GET \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: Bearer <token>'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("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://payments.sandbox.lerian.net/v1/boletos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://payments.sandbox.lerian.net/v1/boletos"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"amount": "<string>",
"cancelable": true,
"createdAt": "<string>",
"dueDate": "<string>",
"id": "<string>",
"kind": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"status": "<string>",
"type": "<string>",
"updatedAt": "<string>",
"barcode": "<string>",
"canceledAt": "<string>",
"cancellationReason": "<string>",
"digitableLine": "<string>",
"discount": {
"amount": "<string>",
"limitDate": "<string>",
"type": "<string>"
},
"errorMessage": "<string>",
"failedAt": "<string>",
"fine": {
"amount": "<string>",
"type": "<string>"
},
"guarantor": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"inactivatedAt": "<string>",
"installmentLabel": "<string>",
"instructions": "<string>",
"interest": {
"amount": "<string>",
"type": "<string>"
},
"midazOperationId": "<string>",
"providerId": "<string>",
"qrCode": "<string>",
"seriesId": "<string>",
"settledAmount": "<string>",
"settledAt": "<string>"
}
],
"limit": 123,
"page": 123,
"total": 123
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}"<string>"{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Authorizations
JWT bearer token issued by the identity provider.
Headers
Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.
Query Parameters
Status filter.
Available options:
PENDING, CREATED, SETTLED, CANCELED, INACTIVATED, FAILED Example:
"CREATED"
Boleto kind filter.
Available options:
SINGLE, INSTALLMENT Example:
"SINGLE"
Boleto type filter.
Available options:
TRADITIONAL, QR_CODE, HYBRID Example:
"TRADITIONAL"
Created-from date, inclusive.
Example:
"2026-01-01"
Created-to date, inclusive.
Example:
"2026-12-31"
Due-date lower bound, inclusive.
Example:
"2026-02-01"
Due-date upper bound, inclusive.
Example:
"2026-11-30"
Page number, one-based.
Required range:
x >= 1Example:
1
Items per page.
Required range:
1 <= x <= 100Example:
20
Was this page helpful?

