Guia
Boleto
Emita boletos com vencimento, juros, multa e desconto; baixe o PDF e receba a compensação por webhook.
1. Emita o boleto
O documento (CPF/CNPJ) do pagador é obrigatório. Juros e multa em pontos-base (100 = 1%).
POST /v1/boletos
curl -X POST https://api2.bosspay.io/v1/boletos \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: fatura-778" \
-d '{
"amount": "48900",
"dueDate": "2026-10-15",
"customer": { "name": "Oficina Lima Ltda", "document": "11222333000181" },
"fineBps": 200,
"interestBps": 100,
"externalId": "fatura-778"
}'2. Entregue ao pagador
Use boleto.digitableLine (linha digitável) ou baixe o PDF em GET /v1/boletos/:id/pdf.
3. Receba a compensação
boleto.paid e payment.approved chegam quando o banco confirma. Boleto em aberto pode ser baixado com POST /v1/boletos/:id/cancel.
Webhooks relevantes
payment.createdboleto.paidpayment.approvedpayment.failedBom saber
- Estorno de boleto pago é feito por transferência ao pagador, pelo painel.