Docs/API Reference/CNAB
DashboardGitHub

O módulo CNAB permite gerar arquivos de remessa e processar arquivos de retorno nos formatos CNAB 240 e CNAB 400. Suporte aos bancos: Itaú, Banco do Brasil, Bradesco e Caixa Econômica Federal.

Endpoints

#
MétodoEndpointDescrição
POST/api/cnab/remessaGerar arquivo de remessa (CNAB 240/400)
POST/api/cnab/retornoUpload de arquivo de retorno bancário
GET/api/cnab/filesListar arquivos gerados
GET/api/cnab/files/:id/downloadDownload de arquivo
ℹ️

Todos os endpoints requerem autenticação via JWT (Authorization: Bearer TOKEN).


Gerar remessa

POST/api/cnab/remessa

Gera um arquivo de remessa no formato CNAB 240 ou CNAB 400 com as dívidas selecionadas. O arquivo segue o layout do banco especificado.


Upload de retorno

POST/api/cnab/retorno

Processa um arquivo de retorno bancário. Os pagamentos identificados atualizam automaticamente o status das dívidas correspondentes no sistema.


Listar arquivos

GET/api/cnab/files

Retorna a lista de arquivos CNAB gerados e processados, com data, tipo (remessa/retorno), banco e status.


Download de arquivo

GET/api/cnab/files/:id/download

Faz o download de um arquivo CNAB específico. O arquivo é retornado em formato texto plano com o encoding correto para o banco.