Pular para o conteúdo principal

Processar Arquivo de Retorno CNAB

Processa arquivos de retorno bancário nos padrões CNAB 240 e CNAB 400. Atualiza automaticamente o status dos boletos com base nas informações do banco.

Retorno CNAB 240​

POST /boleto/cnab/retorno/240

Processa arquivo de retorno no padrão CNAB 240.

Body​

Envie o arquivo via multipart/form-data ou como texto no body:

Opção 1 — Upload de arquivo:

curl -X POST "https://api.engineapi.com.br/boleto/cnab/retorno/240" \
  -H "x-api-key: sua-api-key" \
  -F "file=@retorno.txt"

Opção 2 — Conteúdo no body:

curl -X POST "https://api.engineapi.com.br/boleto/cnab/retorno/240" \
  -H "x-api-key: sua-api-key" \
  -H "Content-Type: application/json" \
  -d '{"content": "conteudo-do-arquivo-retorno"}'

Resposta (200)​

{
  "processados": 10,
  "pagos": 7,
  "rejeitados": 2,
  "baixados": 1,
  "detalhes": [
    {
      "nossoNumero": "00000001",
      "status": "PAID",
      "valorPago": 150.0,
      "dataPagamento": "2026-02-10"
    }
  ]
}

Retorno CNAB 400​

POST /boleto/cnab/retorno/400

Processa arquivo de retorno no padrão CNAB 400.

Mesmos parâmetros da versão 240.

curl -X POST "https://api.engineapi.com.br/boleto/cnab/retorno/400" \
  -H "x-api-key: sua-api-key" \
  -F "file=@retorno400.txt"

Observações​

  • O arquivo de retorno é fornecido pelo banco após o processamento da remessa.
  • Os boletos são atualizados automaticamente: PAID, REJECTED, CANCELED.
  • Verifique o campo rejeitados para tratar erros de registro.