Sign inSign up

isaacvitor/boletoio

By isaacvitor

Updated about 8 years ago

Tá precisando gerar boletos? BoletoIO pode ser sua solução!

Image
2

459

isaacvitor/boletoio repository overview

BoletoIO

O BoletoIO é uma pequena aplicação baseada em websocket para geração de boletos bancários desenvolvido com a biblioteca Bopepo.

Rodando / Running

Primeiro, baixe o BoletoIO! (mas isso você já sabe...)

docker run -d --name boletoio -p 9092:9092  isaacvitor/boletoio

Para facilitar a nossa vida(a minha principalmente, pois não terei que escrever um documentação extensa) aconselho que você clone a aplicação(NodeJS) BoletoIO-Client-Example

Ai ficou easy peasy, basta dar um npm install e depois um npm run start

Mas o que você precisa saber?

Estando conectado ao BoletoIO sua aplicação precisa emitir um único evento: scktGenerateBoleto passando os dados para a geração do boleto estes, deve estritamente seguir este modelo:

{ cedente : { razaoSocial:'BOLETOIO SISTEMINHA SA', cnpj:'59.199.914/0001-76' }, sacado : { razaoSocial:'PESSOA_OU_EMPRESA_QUE_PAGA SA', cnpj:'91.484.614/0001-41', endereco:{ logradouro:'RUA DAS MANCHAS ESCURAS', bairro:'DISTRITO DA LIMPEZA', numero:'911', cidade:'RECIFE', uf:'PE', cep:'11111-111' } }, sacador : { razaoSocial:'PESSOA_OU_EMPRESA_QUE_EMITE SA', cnpj:'81.236.275/0001-20', endereco:{ logradouro:'RUA SEM MANCHAS', bairro:'ALVEJARES', numero:'001', cidade:'RECIFE', uf:'PE', cep:'22222-222' } }, conta : { banco:'BANCO_ITAU', carteira:{ codigo:109, tipoCobranca:'COM_REGISTRO'//'SEM_REGISTRO' ou 'COM_REGISTRO' }, agencia:1234, digitoAgencia:'5', conta:54321, digitoConta:'6' }, titulo : { numeroDocumento:'NNNN20180518', nossoNumero:'12345678', digitoNossoNumero:'0', //Apenas para caixa econômica parametrosBancarios:{ codigoOperacao:10 }, valor:1000.12, dataDocumento:'18/05/2018', dataVencimento:'18/06/2018', tipoDocumento:'DM_DUPLICATA_MERCANTIL', aceite:'A', desconto:0, deducao:0, mora:0, acrecimo:0, valorCobrado:0 }, boleto:{ localPagamento:'ATE O VENCIMENTO, PREFERENCIALMENTE ITAU. APOS VENCIMENTO SOMENTO ITAU', instrucaoAoSacado:'AQUI VAO INSTRUCOES PARA O SACADO', instrucao1:'PRIMEIRA LINHA DE INSTRUCOES', instrucao2:'SEGUNDA LINHA DE INSTRUCOES', instrucao3:'TERCEIRA LINHA DE INSTRUCOES', instrucao4:'QUARTA LINHA DE INSTRUCOES', instrucao5:'QUINTA LINHA DE INSTRUCOES', instrucao6:'SEXTA LINHA DE INSTRUCOES', instrucao7:'SETIMA LINHA DE INSTRUCOES', instrucao8:'OITAVA LINHA DE INSTRUCOES' } }

Sua aplicação deve escutar o evento scktGenerateBoletoResponse que retornará stream do PDF do boleto.

Para acompanhar possíveis erros na geração do boleto, sua aplicação será notificada através do evento scktGenerateBoletoError.

Outros parâmetros

Abaixo seguem os bancos suportados (parâmetro conta.banco)

  • BANCO_DO_BRASIL
  • BANCO_DO_NORDESTE_DO_BRASIL
  • BANCO_DO_ESTADO_DO_ESPIRITO_SANTO
  • BANCO_SANTANDER
  • BANCO_DO_ESTADO_DO_RIO_GRANDE_DO_SUL
  • BANCO_INTEMEDIUM;
  • CAIXA_ECONOMICA_FEDERAL
  • BANCO_BRADESCO; BANCO_ITAU
  • BANCO_ABN_AMRO_REAL
  • MERCANTIL_DO_BRASIL
  • HSBC
  • BANCO_SAFRA
  • BANCO_SICREDI
  • BANCOOB;

Seja compreensivo

Saiba que essa é uma versão beta do BoletoIO e provavelmente ocorrerão erros por isso, sua sugestão e ajuda serão bem vindas.

That's all folks

Tag summary

Content type

Image

Digest

Size

76.6 MB

Last updated

about 8 years ago

docker pull isaacvitor/boletoio