Gerando um arquivo de remessa
A API de Boleto disponibiliza função para geração do arquivo de remessa, a partir da versão 1.2.0 (07/09/2016).
Os passos para geração de remessa são os seguintes:
- Utilize a função “Boleto – Criar Arquivo de Remessa CNAB” passando os dados básicos da carteira. Esses dados consistem nas informações dos grupos: “Dados do beneficiário”, “Dados da carteira” e “Arquivo de remessa” descritos nos parâmetros do boleto, observe também anotações específicas na documentação individual das carteiras. Os dados são passados num Mapa;
- Após criar uma remessa é necessário adicionar o(s) boleto(s) que serão enviados, normalmente isso é feito num laço de repetição (loop), com os dados obtidos através de uma (ou mais) consulta ao do banco de dados;
- Adicione todos os boletos desejado usando a função “Boleto – Adicionar boleto à remessa”, neste processo são informados todos os dados do boleto num mapa, incluindo informações retornadas pela função de geração de boleto (EX: “NOSSO_NUMERO_DV”), além das informações do grupo “Arquivo de remessa”. Em especial os seguintes parâmetros: “OCORRENCIA”, “PROTESTO_DIAS” (Se houver).
- Os boletos serão adicionados no arquivo, na ordem que forem adicionados.
- Ao final da adição de todos os boletos utilize a função “Boleto – Finalizar arquivo de remessa” para gerar o arquivo TXT que deve ser enviado para o banco:
- Esta função pode gerar um arquivo em disco (no servidor), ou retornar o conteúdo texto, que pode ser salvo ou disponibilizado para cópia.
- O envio do arquivo para o banco ocorre de acordo com procedimentos que devem ser passados pelo banco. Pode consistir em envio de arquivo através do site do banco, FTP, ou outras formas, consulte o gerente da conta para maiores informações.
Importante
Nem todas as carteiras suportadas pela rotina de impressão de bloquetos tem suporte de geração de arquivo de remessa. É necessário informar os parâmetros do boleto, conforme cada uma das carteiras suportadas: