Emitir Boleto

POST /boletos

Emite e registra um boleto bancário online no banco. Retorna linha digitável, código de barras e PIX.

Autenticação

x-api-key: {apiKey}

Parâmetros Obrigatórios

Campo	Tipo	Descrição
issuerId	string	ID da empresa emissora
bankAccountId	string	ID da conta bancária cadastrada
valor	number	Valor do boleto (mín. R$ 0,01)
vencimento	string	Data de vencimento (ISO 8601: "2026-03-15")
pagadorCpfCnpj	string	CPF ou CNPJ do pagador
pagadorNome	string	Nome completo do pagador

Parâmetros Opcionais

Campo	Tipo	Descrição
pagadorEndereco	string	Endereço do pagador
pagadorCidade	string	Cidade do pagador
pagadorUf	string	UF do pagador
pagadorCep	string	CEP do pagador
descricao	string	Descrição/histórico do boleto
instrucoes	string	Instruções para o caixa
nossoNumero	string	Nosso número (gerado automaticamente se omitido)
valorDesconto	number	Valor do desconto
valorMulta	number	Valor da multa por atraso
valorJuros	number	Valor de juros por dia

Exemplo

curl -X POST https://api.engineapi.com.br/boletos \
  -H "x-api-key: SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "issuerId": "ISSUER_ID",
    "bankAccountId": "BANK_ACCOUNT_ID",
    "valor": 250.00,
    "vencimento": "2026-03-15",
    "pagadorCpfCnpj": "12345678909",
    "pagadorNome": "João da Silva",
    "pagadorEndereco": "Rua das Flores, 100",
    "pagadorCidade": "São Paulo",
    "pagadorUf": "SP",
    "pagadorCep": "01000000",
    "descricao": "Mensalidade Fevereiro/2026",
    "valorMulta": 5.00,
    "valorJuros": 0.33
  }'

Resposta (201)

{
  "success": true,
  "message": "Boleto 000001234 emitido (REGISTERED)",
  "data": {
    "id": "uuid-do-boleto",
    "nossoNumero": "000001234",
    "valor": 250.0,
    "vencimento": "2026-03-15",
    "status": "REGISTERED",
    "linhaDigitavel": "75691.23456 78901.234567 89012.345678 1 23450000025000",
    "codigoBarras": "75691234567890123456789012345678123450000025000",
    "pixQrCode": "data:image/png;base64,iVBOR...",
    "pixCopiaECola": "00020126580014br.gov.bcb.pix...",
    "pagadorNome": "João da Silva",
    "pagadorCpfCnpj": "12345678909",
    "protocoloBanco": "ABC123"
  }
}

Status do Boleto

Status	Descrição
PENDING	Aguardando registro no banco
REGISTERED	Registrado com sucesso
PAID	Pago pelo pagador
OVERDUE	Vencido
CANCELED	Cancelado/baixado
ERROR	Erro no registro