Arquivos CNAB 240 e 400
Visão Geral
Seção intitulada “Visão Geral”O padrão CNAB (Centro Nacional de Automação Bancária) define o formato de arquivos para troca de informações entre empresas e bancos. Através destes endpoints você pode gerar arquivos de remessa para registro de boletos e processar arquivos de retorno com informações de pagamento, baixas e outras ocorrências.
Endpoint Base
Seção intitulada “Endpoint Base”https://sandbox.boletocloud.com/api/v1/arquivos/cnabOperações Disponíveis
Seção intitulada “Operações Disponíveis”A tabela abaixo resume todas as operações disponíveis para arquivos CNAB:
Remessa
Seção intitulada “Remessa”| Operação | Método | Endpoint | Descrição |
|---|---|---|---|
| Criar Remessa | POST | /arquivos/cnab/remessas | Gera arquivo CNAB para registro de boletos |
| Obter Remessa | GET | /arquivos/cnab/remessas/{token} | Recupera arquivo de remessa pelo token |
| Listar Remessas | GET | /arquivos/cnab/remessas?data={data}&conta={conta} | Lista remessas disponíveis por data e conta |
Retorno
Seção intitulada “Retorno”| Operação | Método | Endpoint | Descrição |
|---|---|---|---|
| Processar Retorno | POST | /arquivos/cnab/retornos | Processa arquivo de retorno (upload manual) |
| Obter Retorno | GET | /arquivos/cnab/retornos/{token} | Recupera JSON de retorno pelo token |
| Listar Retornos | GET | /arquivos/cnab/retornos?data={data}&conta={conta} | Lista retornos disponíveis por data e conta |
Ciclo de Vida CNAB
Seção intitulada “Ciclo de Vida CNAB”O diagrama abaixo mostra o fluxo completo de integração via arquivos CNAB:
┌─────────────────────────────────────────────────────────────────────────────────┐│ CRIAÇÃO DOS BOLETOS ││ ││ POST /boletos, /carnes, /batch/boletos ││ ► Boletos criados com boleto.conta.token ││ ► Status: CRIADO (pendente de registro) ││ │└────────────────────────────────────┬────────────────────────────────────────────┘ │ ▼┌─────────────────────────────────────────────────────────────────────────────────┐│ ★ GERAR ARQUIVO DE REMESSA ★ ││ ││ POST /arquivos/cnab/remessas ││ ► Seleciona boletos pendentes da conta bancária ││ ► Gera arquivo CNAB 240 ou CNAB 400 ││ ► Retorna arquivo para download ││ │└────────────────────────────────────┬────────────────────────────────────────────┘ │ ┌────────────────┴────────────────┐ ▼ ▼┌─────────────────────────────────┐ ┌─────────────────────────────────┐│ PLANO GRATUITO │ │ PLANO PERSONALIZADO ││ │ │ ││ Enviar arquivo manualmente │ │ Arquivo enviado ││ via Internet Banking │ │ automaticamente via VAN ││ │ │ │└────────────────┬────────────────┘ └────────────────┬────────────────┘ └────────────────────┬────────────────┘ ▼┌─────────────────────────────────────────────────────────────────────────────────┐│ BANCO PROCESSA ││ ││ ► Registra boletos na base centralizada (CIP) ││ ► Recebe pagamentos via boleto ou PIX ││ ► Processa baixas, protestos e outras instruções ││ ► Gera arquivo(s) de retorno com as ocorrências ││ │└────────────────────────────────────┬────────────────────────────────────────────┘ │ ┌────────────────┴────────────────┐ ▼ ▼┌─────────────────────────────────┐ ┌─────────────────────────────────┐│ PLANO GRATUITO │ │ PLANO PERSONALIZADO ││ │ │ ││ Baixar arquivo de retorno │ │ Arquivo recebido ││ via Internet Banking │ │ automaticamente via VAN ││ │ │ ││ POST /arquivos/cnab/retornos │ │ GET /arquivos/cnab/retornos ││ (upload do arquivo) │ │ (consulta por token) ││ │ │ │└────────────────┬────────────────┘ └────────────────┬────────────────┘ └────────────────────┬────────────────┘ ▼┌─────────────────────────────────────────────────────────────────────────────────┐│ ★ PROCESSAR ARQUIVO DE RETORNO ★ ││ ││ ► JSON com ocorrências: REGISTRO_CONFIRMADO, LIQUIDACAO, BAIXA, etc. ││ ► Boletos atualizados automaticamente na plataforma ││ ► Informações de pagamento: valor pago, data, juros/mora ││ │└─────────────────────────────────────────────────────────────────────────────────┘Resumo dos Endpoints por Etapa
Seção intitulada “Resumo dos Endpoints por Etapa”| Etapa | Endpoints | Descrição |
|---|---|---|
| Gerar Remessa | POST /arquivos/cnab/remessas | Gera arquivo CNAB com boletos pendentes |
| Consultar Remessa | GET /arquivos/cnab/remessas/{token} | Recupera arquivo já gerado |
| Listar Remessas | GET /arquivos/cnab/remessas?data=&conta= | Lista remessas por data/conta |
| Processar Retorno | POST /arquivos/cnab/retornos | Envia arquivo de retorno para processamento |
| Consultar Retorno | GET /arquivos/cnab/retornos/{token} | Recupera JSON de retorno processado |
| Listar Retornos | GET /arquivos/cnab/retornos?data=&conta= | Lista retornos por data/conta |
Formatos Suportados
Seção intitulada “Formatos Suportados”| Formato | Descrição | Características |
|---|---|---|
| CNAB 240 | Padrão mais moderno | Mais flexível para múltiplas transações diárias, facilita conciliação automática |
| CNAB 400 | Padrão legado | Ainda utilizado por alguns bancos, estrutura mais simples |
Detalhes das Operações
Seção intitulada “Detalhes das Operações”Remessa
Seção intitulada “Remessa” Criar Remessa (POST) Gere arquivo CNAB para envio ao banco com boletos pendentes de registro.
Obter Remessa (GET) Recupere um arquivo de remessa já gerado através do seu token.
Listar Remessas (GET) Liste os arquivos de remessa disponíveis por data e conta bancária.
Retorno
Seção intitulada “Retorno” Processar Retorno (POST) Envie arquivo de retorno para processamento manual e receba JSON com ocorrências.
Obter Retorno (GET) Recupere o JSON de um arquivo de retorno já processado através do token.
Listar Retornos (GET) Liste os arquivos de retorno disponíveis por data e conta bancária.
Veja Também
Seção intitulada “Veja Também” Visão Geral Remessa Conceitos e fluxo de arquivos de remessa
Visão Geral Retorno Conceitos e fluxo de arquivos de retorno
Boletos Criar e gerenciar boletos via API
Status & Erros Códigos de status e tratamento de erros