Painel de controle


Boleto Bancário

API Maker completa para emissão de boleto de diversos bancos.

Esta é a API Maker ideal para o seu sistema de Boleto Bancário.

API Maker completa com fluxos e bibliotecas necessárias para a emissão e impressão de boleto de diversos bancos: Bradesco, Banco do Brasil, Caixa Econômica, HSBC e outros.

Os boletos já são gerados automaticamente com o código de barras e linha digitável e no formato Esta é uma Aplicação de simples utilização, bastando preencher uma lista com os dados do boleto e chamar a função para que seja gerado um arquivo PDF do boleto.

Funções e fluxos auxiliáres para remessa e retorno, homologado apenas para o banco: CAIXA

Instalação no Maker
  1. Após baixar a versão desejada, acesse o sistema onde deseja instalar a API Maker;
  2. Feche o editor de fluxo e o cadastro de funções se estiverem abertos;
  3. Importe todos os arquivos (.frz).
Instalação no Webrun
  1. Copie a pasta "Maker.Commons" para a pasta "Webrun 2\systems";
  2. Reinicie o tomcat;
  3. Tente acessar o sistema, pode ocorrer um erro ou após a tela de login;
  4. Reinicie novamente o tomcat (Sem republicar);
  5. Acesse novamente o sistema.
Exemplos

Os exemplos de uso das funções se encontram na pasta EXEMPLOS.

Gerar Boleto Bancário (Dinamico)

Gera um boleto bancário para diferentes bancos em PDF.

Parâmetro 1

Código do banco:

  • 001 - Banco do Brasil
  • 237 - Bradesco
  • 356 - Banco Real
  • 104 - Caixa Econômica
  • 151 - Nossa Caixa
  • 399 - HSBC
  • 341 - Itaú
  • 033 - Santander
  • 409 - Unibanco

Parâmetro 2

Mapeamento ou lista de mapeamentos com os seguintes itens:

  • ARQUIVO_BOLETO - Nome do arquivo PDF que deve ser gerado, deixe em branco para que o sistema gere um nome automaticamente
  • CEDENTE_NOME - Nome do cedente
  • CEDENTE_LOGO - Imagem do cedente, será impressa na parte superior da página
  • DESCRICOES - Texto que irá ser impresso no topo da página descrevendo o boleto
  • CARTEIRA - Código da certeira de cobrança no banco
  • AGENCIA - Número da agência, sem o dígito
  • AGENCIA_DV - Digito veriricador da agência
  • CONTA_CORRENTE - Número da conta corrente sem o dígito
  • CONTA_CORRENTE_DV - Digito veriricador da conta corrente
  • DATA_DOCUMENTO - Data do documento
  • DATA_PROCESSAMENTO - Data do processamento
  • DATA_VENCIMENTO - Data de vencimento
  • INSTRUCOES - Instruções de recebimento impressas no corpo do boleto, até 5 linhas
  • INSTRUCAO1..INSTRUCAO5 - Linha individual da instrução
  • NOSSO_NUMERO_DV - nosso número calculado pela API.
  • NUMERO_DOCUMENTO
  • VALOR_BOLETO
  • ACRESCIMO
  • LOCAL_PAGAMENTO
  • LOCAL_PAGAMENTO2
  • VALOR_MOEDA
  • ESPECIE_DOCUMENTO
  • MOEDA
  • ACEITE
  • NUMERO_CONVENIO
  • CODIGO_OPERACAO
  • CODIGO_FORNECIDO_AGENCIA
  • CODIGO_FORNECIDO_AGENCIA_DV
  • SACADO_NOME
  • SACADO_ENDERECO
  • SACADO_BAIRRO
  • SACADO_CIDADE
  • SACADO_UF
  • SACADO_CEP
  • SACADO_CPF
  • COD_CLIENTE - Santander
  • IOS

Parâmetro 3

Modelo de impressão:

Retorno:

Mapa com os seguintes itens:

  • ARQUIVO_BOLETO - Nome do arquivo PDF gerado no servidor.
  • CODIGO_BARRAx - Código de barra gerado para o boleto X, haverá 1 parâmetro desse para cada boleto gerado.
  • LINHA_DIGITAVELx - Linha digitável de barra gerado para o boleto X, haverá 1 parâmetro desse para cada boleto gerado.
  • NOSSO_NUMERO_DVx - DV do nosso número calculado pela API.
  • NOSSO_NUMEROx - Nosso número do boleto.
  • NOSSO_NUMERO_FORMATADOx - Nosso número + DV conforme formação do banco (como impresso no PDF).
  • IMAGEM_CODIGO_BARRASx - Caminho da imagem do código de barras do boleto (só é gerado se for informado o parâmetro "GERAR_IMAGEM_CODIGO_BARRAS")  

Parâmetros básicos para a API de Boleto bancário

A função de geração de boleto recebe três parâmetros, o primeiro é o código do banco na FEBRABAN, o segundo é o modelo de impressão, que pode ser um dos seguintes:

  1. M1RE - Modelo 1 - Recibo de entrega e sacado;
  2. M1RS - Modelo 2 - Recibo do sacado e texto;
  3. M2B - Modelo 3 - Dois boletos por página;
  4. M2AB - Modelo 4 - Dois boletos com recibo;
  5. M3AE - Modelo 5 - Três boletos com recibo à esquerda;
  6. M1CDF - Modelo 6 - Carta dupla face 1.

E no terceiro ele espera que todos os dados de um boleto sejam passados em um mapa. Pode ser passado um único Mapa ou uma Lista contendo mapas com os elementos descritos abaixo.

Dados do cedente (emissor)

  • CEDENTE_NOME - Nome do cedente (emissor) [OBRIGATÓRIO];
  • CEDENTE_FONE - Telefone do cedente
  • CEDENTE_EMAIL - Email do cendente
  • CEDENTE_LOGRADOURO - Endereço do cendente [OBRIGATÓRIO];
  • CEDENTE_BAIRRO
  • CEDENTE_MUNICIPIO
  • CEDENTE_UF
  • CEDENTE_CEP
  • CEDENTE_DOC - CNPJ ou CPF do cedente [OBRIGATÓRIO];
  • CEDENTE_LOGO - Logomarca do cedente em formato JPEG.

Dados da carteira

Essas informações mudam de acordo o banco e carteira utilizado. Verifique a documentação sobre as carteiras suportadas para obter informações sobre quais parâmetros passar para cada banco e carteira.

  • CARTEIRA
  • AGENCIA
  • AGENCIA_DV
  • CONTA_CORRENTE
  • CONTA_CORRENTE_DV
  • NUMERO_CONVENIO
  • CODIGO_OPERACAO
  • CODIGO_FORNECIDO_AGENCIA
  • CODIGO_FORNECIDO_AGENCIA_DV
  • COD_CLIENTE
  • CARTEIRA_MODALIDADE
  • MODELO_BOLETO - Usa para CEF para informa se é SIGCB ou SIGCB;
  • IOS

Dados do sacado (cliente)

  • SACADO_NOME - Nome ou razão social do sacado;
  • SACADO_ENDERECO
  • SACADO_BAIRRO
  • SACADO_CIDADE
  • SACADO_UF
  • SACADO_CEP
  • SACADO_CPF - CPF ou CNPJ do sacado;

Dados do documento

  • VALOR_BOLETO - Valor do boleto em reais, com até 2 casas decimais (Numérico)  [OBRIGATÓRIO];
  • ACRESCIMO - Valor dos acréscimos, com até 2 casas decimais (Numérico);
  • DATA_DOCUMENTO - Data de emissão do documento que gerou a cobrança   (Data) [OBRIGATÓRIO];
  • DATA_PROCESSAMENTO - Data em que as informações do boleto foram geradas/atualizadas/processadas (Data) [OBRIGATÓRIO];
  • DATA_VENCIMENTO -  [OBRIGATÓRIO]
  • NUMERO_DOCUMENTO (Letras) - [RECOMENDADO];
  • ESPECIE_DOCUMENTO -  [RECOMENDADO];
  • NOSSO_NUMERO - Número único de identidficação do boleto [OBRIGATÓRIO];
  • NOSSO_NUMERO_DV - Digito verificador do nosso número, deixe em branco para cálculo automático;
  • LOCAL_PAGAMENTO  [OBRIGATÓRIO]
  • LOCAL_PAGAMENTO2  [OBRIGATÓRIO]
  • ACEITE: (Letras)
  • INSTRUCOES
    • INSTRUCAO1
    • INSTRUCAO2
    • INSTRUCAO3
    • INSTRUCAO4
    • INSTRUCAO5
  • DESCRICOES  (Letras)
  • MOEDA  (Letras)
  • VALOR_MOEDA

Configuração

  • FORCA_QUEBRA_PAGINA - Força a impressão de 1 boleto por página, mesmo para os layouts com 2 ou mais boletos por página (Lógico);
  • MARGEM_SUPERIOR_ADICIONAL - Deslocamento adicional do inicio da página para o inicio do boleto (Valor em milímetros), do tipo Inteiro;
  • IMPRIME_ACEITE
  • INSTRUCOES_RECIBO - Instruções a serem impressas no recibo do sacado apenas;
  • ARQUIVO_BOLETO: Caminho completo do arquivo PDF que deve ser gerado com os boletos, se não informado a API irá gerar um arquivo na pasta temporária do Webrun (Letras).
  • GERAR_IMAGEM_CODIGO_BARRAS - Indica se o código de barras deve ser exportado como imagem e retornado nos parâmetros de retorno;
  • TESTAR_CAMPOS - Campo opcional para verificação dos campos. Ex: true - ativado, false - desativado.

Boleto bancário - Versão 1.9.7

Esta é a nova versão da API de Boleto Bancário.

Resumo

  • Número de versão: 1.9.7
  • Data de liberação: 23/04/2014

Principais melhorias

  • Geração de arquivo REMESSA;
  • Correções para o Banco do Brasil;
  • Novo Banco: Cecred.

Boleto bancário - Versão 1.9.6

Esta é a nova versão da API de Boleto Bancário.

Resumo

  • Número de versão: 1.9.6
  • Data de liberação: 09/01/2014

Principais melhorias

  • Correção do Boleto (linha Digitavel) - HSBC
  • Correção do Layout do campo nosso numero - HSBC

Boleto bancário - Versão 1.9.5

Esta é a nova versão da API de Boleto Bancário.

Resumo

  • Número de versão: 1.9.5
  • Data de liberação: 20/09/2013

Principais melhorias

  • Caixa Economica , agora permite nosso numero com 17 digitos;
  • Banco do Brasil, O campo nosso numero no layout deve Exibir "X" quando dv igual a 10;
  • Posicionamento do Layout ;
  • Correção no Layout de alguns modelos.