Boleto

Emitir

curl -X POST https://api.gateway.example/v1/boletos \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amountInCents": 5000,
    "payerDocument": "12345678900",
    "payerName": "Maria da Silva"
  }'

const boleto = await gateway.boletos.create({
  amountInCents: 5000,
  payerDocument: '12345678900',
  payerName: 'Maria da Silva',
});

{
  "id": "9480f523-...",
  "object": "boleto",
  "status": "pending_payment",
  "amountInCents": 5000,
  "ourNumber": "mock_boleto_...",
  "barcode": "00190000090000000000000000000000000000000000",
  "digitableLine": "00190.00009 00000.000000 00000.000000 0 00000000000000",
  "dueDate": "2026-08-28"
}

payerDocument e payerName são obrigatórios — todo boleto precisa de um sacado identificável. O vencimento (dueDate) é definido automaticamente (alguns dias de folga a partir da criação) — não é configurável via /v1/boletos nesta entrega.

Consultar

GET /v1/boletos/:id reconsulta ao vivo — barcode/digitableLine voltam de novo:

const boleto = await gateway.boletos.get('pay_123');

Cancelar

Só funciona enquanto o boleto ainda não foi pago:

await gateway.boletos.cancel('pay_123');

Confirmação de pagamento

Boleto não confirma pagamento em tempo real — a compensação bancária pode levar até alguns dias úteis. Trate o webhook boleto.paid/payment.paid (ver Webhooks); não existe hoje um jeito de "adiantar" essa confirmação, nem em sandbox.