Arquivo de Remessa CNAB
Arquivo de Remessa CNAB
Seção intitulada “Arquivo de Remessa CNAB”O arquivo de remessa é um arquivo de texto no formato CNAB (Centro Nacional de Automação Bancária) que contém as instruções de registro de boletos junto ao banco. Ele é o meio pelo qual o banco recebe e processa as cobranças.
O Que é o Arquivo de Remessa?
Seção intitulada “O Que é o Arquivo de Remessa?”| Característica | Descrição |
|---|---|
| Formato | CNAB 240 ou CNAB 400 (conforme configuração da conta bancária) |
| Conteúdo | Boletos pendentes de envio ao banco |
| Codificação | text/plain; charset=utf-8 |
| Nomenclatura | Gerada automaticamente pelo sistema (ex: CB070402.REM) |
| Destino | Deve ser enviado ao banco via Internet Banking ou VAN |
Endpoints Disponíveis
Seção intitulada “Endpoints Disponíveis”A API oferece três endpoints para trabalhar com arquivos de remessa:
Criar Remessa (POST) Gera um novo arquivo CNAB com todos os boletos pendentes de envio ao banco
Obter Remessa (GET) Recupera um arquivo de remessa já gerado através do seu token
Listar Remessas (GET) Lista os arquivos de remessa disponíveis por data e conta bancária
Ciclo de Vida do Boleto
Seção intitulada “Ciclo de Vida do Boleto”A geração de remessa se encaixa na etapa de envio ao banco, após a criação dos boletos:
┌─────────────────────────────────────────────────────────────────────┐│ CRIAÇÃO DOS BOLETOS ││ ││ POST /boletos (individual) ││ POST /carnes (carnê) ││ POST /batch/boletos (lote) ││ ││ ► Boletos criados com boleto.conta.token ││ ► PDF gerado, mas boleto NÃO registrado no banco │└────────────────────────────────────┬────────────────────────────────┘ │ ▼┌─────────────────────────────────────────────────────────────────────┐│ ★ GERAR ARQUIVO DE REMESSA ★ ││ ││ POST /arquivos/cnab/remessas ││ ││ ► Arquivo gerado com boletos pendentes ││ ► Enviar arquivo ao banco (Internet Banking / VAN) │└────────────────────────────────────┬────────────────────────────────┘ │ ▼┌─────────────────────────────────────────────────────────────────────┐│ BANCO PROCESSA O ARQUIVO ││ ││ ► Banco registra os boletos ││ ► Banco disponibiliza arquivo de RETORNO │└────────────────────────────────────┬────────────────────────────────┘ │ ▼┌─────────────────────────────────────────────────────────────────────┐│ PROCESSAR ARQUIVO DE RETORNO ││ ││ POST /arquivos/cnab/retornos ││ ││ ► Boletos atualizados: REGISTRADO, REJEITADO, PAGO, BAIXADO │└─────────────────────────────────────────────────────────────────────┘Quando Usar Arquivo de Remessa
Seção intitulada “Quando Usar Arquivo de Remessa”Cenários Recomendados
Seção intitulada “Cenários Recomendados”| Cenário | Exemplo |
|---|---|
| Registro em lote | Registrar no banco todos os boletos gerados no dia |
| Integração via arquivo | Conta bancária configurada para troca de arquivos (sem API/webservice bancário) |
| Controle manual de envio | Decidir o momento exato de registrar os boletos no banco |
| Conciliação bancária | Manter controle dos boletos enviados por arquivo |
Pré-requisitos
Seção intitulada “Pré-requisitos”- Possuir uma conta bancária cadastrada com token válido
- Ter boletos criados que ainda não constam em nenhuma remessa
- Utilizar a nova forma de geração de boletos com
boleto.conta.token
Comportamento por Tipo de Comunicação
Seção intitulada “Comportamento por Tipo de Comunicação”| Tipo de Comunicação | Gera Remessa? | O que acontece |
|---|---|---|
| Arquivo CNAB (manual) | Sim | Arquivo gerado pela API, você envia manualmente ao banco via Internet Banking ou VAN |
| API/Webservice (automático) | Não necessário | Boletos são registrados automaticamente no banco via integração direta |
| VAN (automático) | Não necessário | Boletos são enviados automaticamente via rede de valor agregado |
Fluxo Completo
Seção intitulada “Fluxo Completo”- Criar boletos usando o endpoint Criar Boleto com
boleto.conta.token - Gerar arquivo de remessa usando Criar Remessa
- Salvar o arquivo retornado (o nome está no header
Content-Disposition) - Enviar o arquivo ao banco através do Internet Banking ou VAN
- Aguardar o banco processar e disponibilizar o arquivo de retorno
- Processar o arquivo de retorno usando o endpoint CNAB Retorno
Veja Também
Seção intitulada “Veja Também” Visão Geral CNAB Conceitos gerais sobre arquivos CNAB
Arquivo de Retorno Processar retornos do banco
Criar Boleto Criar boletos com token da conta bancária
Conta Bancária Configurar a conta bancária