Documentação SeuBoleto

Gere boletos híbridos (boleto + Pix) via API e receba um link público permanente para visualização.

Base URL

Produção: https://seuboleto.online

Autenticação

Envie a API Key no header:

Authorization: Bearer <sua_api_key>

Utilize seu token para receber seus boletos e acessar pela a URL gerada.

POST /api/v1/boletos

Gera boleto + Pix

O POST irá gerar linha digitável, barcode44, QR Pix e retornar um link público.

Body (modelo genérico)

{
  "bank": "341",
  "carteira": "109",
  "agencia": "6516",
  "conta": "06459",
  "dacAgConta": "6",

  "convenio": "123456",
  "nossoNumero": "01000071",

  "vencimento": "2026-01-31",
  "valorCentavos": 99099,

  "pixKey": "seuemail@dominio.com.br",
  "merchantName": "SEUBOLETO SERVICOS DE TECNOLOGIA LTDA.",
  "merchantCity": "ATIBAIA",
  "txid": "SEUBOLETO000569071",
  "documento": "000569071",

  "emissao": "2026-01-22",
  "multa": 0.02,
  "juros": 0.05,

  "pagador": {
    "name": "NOME DO PAGADOR",
    "document": "000.000.000-00",
    "address": "Rua Exemplo, 123",
    "city": "São Paulo",
    "state": "SP"
  },
  "beneficiario": {
    "name": "BENEFICIÁRIO LTDA",
    "document": "00.000.000/0001-00",
    "address": "Av. Central, 1000",
    "city": "São Paulo",
    "state": "SP"
  }
}

Exemplo CURL

curl -s -X POST "http://seuboleto.online/api/v1/boletos" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <sua_api_key>" \
  -d '{
    "bank":"001",
    "carteira":"21",
    "convenio":"123456",
    "nossoNumero":"01000074",
    "vencimento":"2026-01-31",
    "valorCentavos":9099,
    "pixKey":"seuemail@dominio.com.br",
    "merchantName":"SEUBOLETO SERVICOS DE TECNOLOGIA LTDA.",
    "merchantCity":"SÃO PAULO",
    "txid":"SEUBOLETO000569071",
    "documento":"000569071",
    "multa":0.02,
    "juros":0.05,
    "pagador":{"name":"NOME DO PAGADOR","document":"000.000.000-00","address":"Rua Exemplo, 123","city":"São Paulo","state":"SP"},
    "beneficiario":{"name":"BENEFICIÁRIO LTDA","document":"00.000.000/0001-00","address":"Av. Central, 1000","city":"São Paulo","state":"SP"}
  }'

Resposta (exemplo)

{
  "publicId": "jatxpfmkrdp5n0",
  "objectKey": "demo/jatxpfmkrdp5n0.html",
  "publicUrl": "https://seuboleto.online/b/jatxpfmkrdp5n0",
  "linhaDigitavel": "00190.00009 ...",
  "barcode44": "0019...",
  "usage": {
    "yearMonth": "2026-01",
    "used": 2,
    "limit": 5000,
    "remaining": 4998,
    "plan": { "id": "pro", "name": "Pro" }
  }
}

Validações importantes:

vencimento deve ser YYYY-MM-DD
valorCentavos deve ser > 0
pixKey obrigatório
Para carteira não suportada, a API deve responder 400 (erro de regra bancária)

GET /b/<publicId>

Público (HTML puro)

Retorna o HTML final do boleto diretamente do SeuBoleto. Ideal para impressão, WhatsApp e e-mail. Para clientes Protheus, utiliza um campo customizado no SE1 e guarde o link de cada boleto emitido, assim poderá utilizar em cartas de cobrança padrão.

Exemplo

https://seuboleto.online/b/jatxpfmkrdp5n0

GET /api/v1/banks

Bancos (em produção)

Exibe os boletos de quais bancos estão ativos.

CURL

curl -s -X GET "http://seuboleto.online/api/v1/banks" \
  -H "Content-Type: application/json"