curl --request POST \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"dueDate": "2030-01-15",
"midazAccountId": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"type": "TRADITIONAL",
"guarantor": {
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
},
"document": "<string>",
"name": "<string>"
},
"instructions": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://payments.sandbox.lerian.net/v1/boletos"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"dueDate\": \"2030-01-15\",\n \"midazAccountId\": \"<string>\",\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"number\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zipCode\": \"<string>\"\n }\n },\n \"type\": \"TRADITIONAL\",\n \"guarantor\": {\n \"address\": {\n \"city\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"number\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '100.00',
dueDate: '2030-01-15',
midazAccountId: '<string>',
payer: {
document: '<string>',
name: '<string>',
address: {
city: '<string>',
complement: '<string>',
neighborhood: '<string>',
number: '<string>',
state: '<string>',
street: '<string>',
zipCode: '<string>'
}
},
type: 'TRADITIONAL',
guarantor: {
address: {
city: '<string>',
complement: '<string>',
neighborhood: '<string>',
number: '<string>',
state: '<string>',
street: '<string>',
zipCode: '<string>'
},
document: '<string>',
name: '<string>'
},
instructions: '<string>'
})
};
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"
payload = {
"amount": "100.00",
"dueDate": "2030-01-15",
"midazAccountId": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"type": "TRADITIONAL",
"guarantor": {
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
},
"document": "<string>",
"name": "<string>"
},
"instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"amount": "<string>",
"createdAt": "<string>",
"dueDate": "<string>",
"id": "<string>",
"providerId": "<string>",
"status": "<string>",
"type": "<string>",
"barcode": "<string>",
"digitableLine": "<string>",
"discount": {
"amount": "<string>",
"limitDate": "<string>",
"type": "<string>"
},
"fine": {
"amount": "<string>",
"type": "<string>"
},
"instructions": "<string>",
"interest": {
"amount": "<string>",
"type": "<string>"
},
"qrCode": "<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"
}
}"<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"
}
}{
"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"
}
}Issue a single boleto
Creates a new TRADITIONAL boleto via the banking provider. HYBRID (BolePix) and QR_CODE are out of V1 and are refused with 422 PBP-0006.
curl --request POST \
--url https://payments.sandbox.lerian.net/v1/boletos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"dueDate": "2030-01-15",
"midazAccountId": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"type": "TRADITIONAL",
"guarantor": {
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
},
"document": "<string>",
"name": "<string>"
},
"instructions": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://payments.sandbox.lerian.net/v1/boletos"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"dueDate\": \"2030-01-15\",\n \"midazAccountId\": \"<string>\",\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"number\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zipCode\": \"<string>\"\n }\n },\n \"type\": \"TRADITIONAL\",\n \"guarantor\": {\n \"address\": {\n \"city\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"number\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '100.00',
dueDate: '2030-01-15',
midazAccountId: '<string>',
payer: {
document: '<string>',
name: '<string>',
address: {
city: '<string>',
complement: '<string>',
neighborhood: '<string>',
number: '<string>',
state: '<string>',
street: '<string>',
zipCode: '<string>'
}
},
type: 'TRADITIONAL',
guarantor: {
address: {
city: '<string>',
complement: '<string>',
neighborhood: '<string>',
number: '<string>',
state: '<string>',
street: '<string>',
zipCode: '<string>'
},
document: '<string>',
name: '<string>'
},
instructions: '<string>'
})
};
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"
payload = {
"amount": "100.00",
"dueDate": "2030-01-15",
"midazAccountId": "<string>",
"payer": {
"document": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
}
},
"type": "TRADITIONAL",
"guarantor": {
"address": {
"city": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"number": "<string>",
"state": "<string>",
"street": "<string>",
"zipCode": "<string>"
},
"document": "<string>",
"name": "<string>"
},
"instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"amount": "<string>",
"createdAt": "<string>",
"dueDate": "<string>",
"id": "<string>",
"providerId": "<string>",
"status": "<string>",
"type": "<string>",
"barcode": "<string>",
"digitableLine": "<string>",
"discount": {
"amount": "<string>",
"limitDate": "<string>",
"type": "<string>"
},
"fine": {
"amount": "<string>",
"type": "<string>"
},
"instructions": "<string>",
"interest": {
"amount": "<string>",
"type": "<string>"
},
"qrCode": "<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"
}
}"<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"
}
}{
"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.
Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012.
Body
Amount as a decimal string, at most two decimal places.
32"100.00"
Due date, YYYY-MM-DD.
"2030-01-15"
Midaz account the boleto settles into.
Show child attributes
Show child attributes
Boleto type. Only TRADITIONAL is supported in V1. HYBRID (BolePix) and QR_CODE are refused with 422 PBP-0006.
"TRADITIONAL"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

