Boleto Emita boletos bancários integrados à sua operação fiscal. A Engine API conecta diretamente ao Sicoob para registro e rastreamento.
Endpoint base: https://api.engineapi.com.brPré-requisitos
Conta e API Key
Gere sua API Key em Dashboard → Configurações → API Keys .
Empresa emissora cadastrada
POST /companies com os dados da empresa cedente.
Conta bancária cadastrada
Registre a conta bancária Sicoob antes de emitir boletos.
1. Cadastrar Conta Bancária Antes de emitir boletos, registre a conta bancária da empresa:
curl -X POST https://api.engineapi.com.br/issuers/ISSUER_ID/bank-accounts \ -H "x-api-key: SUA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "banco": "756", "bancoNome": "Sicoob", "agencia": "3303", "conta": "123456", "convenio": "3303001", "carteira": "1", "cedente": "Empresa Exemplo Ltda", "cnpjCedente": "11222333000144" }'
{ "success" : true , "message" : "Conta Sicoob (3303/123456) cadastrada com sucesso" , "data" : { "id" : "bank-account-uuid" , "banco" : "756" , "bancoNome" : "Sicoob" , "agencia" : "3303" , "conta" : "123456" } }
2. Listar Contas Bancárias curl https://api.engineapi.com.br/issuers/ISSUER_ID/bank-accounts \ -H "x-api-key: SUA_API_KEY"
3. Emitir Boleto curl -X POST https://api.engineapi.com.br/boleto/boletos \ -H "x-api-key: SUA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "issuerId": "ISSUER_ID", "bankAccountId": "BANK_ACCOUNT_ID", "pagador": { "nome": "João da Silva", "cpf": "12345678901", "endereco": { "logradouro": "Rua Exemplo", "numero": "100", "bairro": "Centro", "cidade": "São Paulo", "uf": "SP", "cep": "01001000" } }, "valor": 250.00, "vencimento": "2026-05-10", "descricao": "Referente à fatura #1234", "numeroDocumento": "NF-1234", "instrucoes": [ "Não receber após o vencimento", "Cobrar multa de 2% após o vencimento" ] }'
const boleto = await fetch ( 'https://api.engineapi.com.br/boleto/boletos' , { method: 'POST' , headers: { 'x-api-key' : process . env . ENGINE_API_KEY ! , 'Content-Type' : 'application/json' , }, body: JSON . stringify ({ issuerId: 'ISSUER_ID' , bankAccountId: 'BANK_ACCOUNT_ID' , pagador: { nome: 'João da Silva' , cpf: '12345678901' , endereco: { logradouro: 'Rua Exemplo' , numero: '100' , bairro: 'Centro' , cidade: 'São Paulo' , uf: 'SP' , cep: '01001000' , }, }, valor: 250.00 , vencimento: '2026-05-10' , descricao: 'Referente à fatura #1234' , numeroDocumento: 'NF-1234' , }), }). then ( r => r . json ()); console . log ( 'Boleto emitido:' , boleto . data . nossoNumero ); console . log ( 'PDF:' , boleto . data . pdfUrl );
Campos de Referência Campo Tipo Obrigatório Descrição issuerIdstring (UUID) Sim ID da empresa cedente bankAccountIdstring (UUID) Sim ID da conta bancária cadastrada pagador.nomestring Sim Nome do pagador pagador.cpf ou cnpjstring Sim Documento do pagador pagador.enderecoobjeto Sim Endereço completo valornúmero Sim Valor em R$ vencimentostring (ISO date) Sim Data de vencimento (YYYY-MM-DD) descricaostring Não Descrição da cobrança numeroDocumentostring Não Número do documento/fatura instrucoesstring[] Não Instruções no boleto (máx. 5 linhas)
Response de Sucesso { "success" : true , "data" : { "id" : "boleto-uuid" , "nossoNumero" : "000000001" , "codigoBarras" : "75691.23456 12345.678901 12345.678901 1 12340000025000" , "linhaDigitavel" : "75691.23456 12345.678901 12345.678901 1 12340000025000" , "status" : "PENDING" , "valor" : 250.00 , "vencimento" : "2026-05-10" , "pdfUrl" : "/boleto/boletos/boleto-uuid/pdf" , "createdAt" : "2026-04-27T02:00:00.000Z" } }
Ciclo de vida do Boleto Status Descrição PENDINGGerado, aguardando registro no banco REGISTEREDRegistrado no Sicoob — pode ser pago PAIDPago pelo sacado OVERDUEVencido sem pagamento CANCELEDCancelado pelo cedente ERRORErro no registro bancário
Consultar Boleto curl https://api.engineapi.com.br/boleto/boletos/BOLETO_ID \ -H "x-api-key: SUA_API_KEY"
Download do PDF curl https://api.engineapi.com.br/boleto/boletos/BOLETO_ID/pdf \ -H "x-api-key: SUA_API_KEY" \ -o boleto.pdf
Cancelar Boleto curl -X POST https://api.engineapi.com.br/boleto/boletos/BOLETO_ID/cancelar \ -H "x-api-key: SUA_API_KEY"
Boletos com status PAID não podem ser cancelados. Boletos OVERDUE podem ser cancelados, mas o pagamento já realizado (se houver) não é revertido automaticamente.
Próximos passos
Webhooks Receba eventos de pagamento em tempo real
Erros e Rejeições Tratamento de erros de registro bancário
