Issuing boletos
Create a boleto your customer pays, track it, and change course when they need more time.
Issue the boleto
POST /v1/boletos (scope boletos:write) creates a boleto available for immediate payment. amount, dueDate, and payerData are required; bolepixEnabled defaults to true.
curl -X POST \
'https://public-sandbox.tryjeeves.com/v1/boletos' \
-H "Authorization: Bearer $JEEVES_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"amount": 5000,
"dueDate": "2026-11-15",
"memo": "Payment for services",
"bolepixEnabled": true,
"payerData": {
"name": "Global Tech",
"personType": "legal",
"documentNumber": "12345678000195",
"email": "finance@globaltech.com",
"phone": { "countryCode": "055", "areaCode": "11", "number": "987654321" },
"address": {
"street": "101 High St.",
"number": "202",
"neighborhood": "Tech Park",
"postalCode": "01001000",
"city": "São Paulo",
"state": "SP"
}
},
"metadata": { "internalReference": "INV-789" }
}'| Field | Notes |
|---|---|
amount | Payment amount, positive. |
dueDate | ISO 8601 YYYY-MM-DD. |
memo | Optional note for the payer, shown on the boleto, max 320 chars. |
payerData | Your customer: personType is natural (CPF, 11 digits) or legal (CNPJ, 14 digits); email, phone and address are optional; when you send address, state is a Brazilian UF code. |
bolepixEnabled | true (default) adds a Pix QR code — instant settlement, boleto marked paid directly. |
fine / interest | Optional late-payment fine and interest terms. |
metadata | Your own key-value reference data. |
Track it
curl 'https://public-sandbox.tryjeeves.com/v1/boletos?page=1&pageSize=20' \
-H "Authorization: Bearer $JEEVES_ACCESS_TOKEN"curl 'https://public-sandbox.tryjeeves.com/v1/boletos/123e4567-e89b-12d3-a456-426614174000' \
-H "Authorization: Bearer $JEEVES_ACCESS_TOKEN"For boletos paid by barcode or digitable line, expect the early payment notice up to one day before final settlement — settlement is guaranteed once noticed. Bolepix payments settle instantly.
Give the payer more time
POST /v1/boletos/{id}/extend moves the due date without cancelling and reissuing:
curl -X POST \
'https://public-sandbox.tryjeeves.com/v1/boletos/123e4567-e89b-12d3-a456-426614174000/extend' \
-H "Authorization: Bearer $JEEVES_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "newDueDate": "2026-12-15" }'Cancel
POST /v1/boletos/{id}/cancel voids an unpaid boleto:
curl -X POST \
'https://public-sandbox.tryjeeves.com/v1/boletos/123e4567-e89b-12d3-a456-426614174000/cancel' \
-H "Authorization: Bearer $JEEVES_ACCESS_TOKEN"