Changelog da API

Histórico das mudanças públicas da API V1, a partir de janeiro de 2026 — o que muda para a sua integração e onde ler os detalhes. As entradas mais recentes vêm primeiro; mudanças anteriores a janeiro de 2026 não são listadas retroativamente.

Tipos de mudança:

• Novidade Funcionalidade nova — aditiva, não exige ação na sua integração. Campos novos em respostas JSON são aditivos: sua integração deve ignorar os campos que não conhece, sem falhar ao recebê-los.
• Correção Comportamento incorreto corrigido
• Melhoria Refinamento de comportamento existente (mensagens de erro, consistência, desempenho)

Versão da plataforma × versão da API

Os números dos títulos, como 0.12.393, identificam entregas da plataforma em produção. Cada entrega recebe um número novo, que aparece no header X-BoletoCloud-Version das respostas da API (exceto no 404 de rota inexistente). A versão da API continua sendo /api/v1: todas as mudanças desta página valem para a V1, sem trocar a URL.

2026-10-10 versão 0.12.398

• Melhoria Rota inexistente em JSON. Rotas inexistentes sob /api passam a responder 404 com JSON e código C1E304DC; em HEAD, a resposta não traz corpo. Status e erros. Códigos de erro.

• Correção Métodos não suportados na obtenção do PDF. Em /api/v1/boletos/{token}, POST, PUT, DELETE, PATCH e TRACE respondem 405 com JSON, código BD7FDA34 e Allow: GET. Em HEAD, a resposta é 405 sem corpo; em OPTIONS, 200 sem corpo; as duas trazem Allow: GET. Status e erros.

• Correção Barra final na URL do boleto. Em /api/v1/boletos/{token}/, métodos diferentes de GET respondem 301 com Location para a URL sem a barra final. Use essa URL diretamente para preservar o método e o corpo. Status e erros.

• Melhoria Formato dos erros 405 e 500. Sob /api, os erros 405 (BD7FDA34) e 500 (179E01F3) em GET e POST têm corpo JSON; em HEAD, não há corpo. Em PUT, DELETE e PATCH, um 500 pode vir sem corpo: trate pelo status HTTP. Status e erros.

2026-09-28 versão 0.12.393

• Correção Endereço do pagador no registro online. O endereço do pagador enviado ao banco no registro online passa a incluir o número e o complemento. Vale para Banco do Brasil, Caixa, Itaú, Safra e Sicredi; no Itaú, também para o endereço do sacador avalista.

2026-09-25 versão 0.12.392

• Correção Cancelamento de protesto na remessa do Santander. Na remessa CNAB 240 do Santander, pedidos de cancelamento de protesto passam a ser enviados sem os segmentos Q e R. Gerar remessa.

2026-09-18 versão 0.12.391

• Melhoria Obter retorno com melhor desempenho. A obtenção do resultado de um retorno por token (GET /api/v1/arquivos/cnab/retornos/{token}) ficou mais rápida. O contrato da resposta não muda. Obter retorno.

• Melhoria Processar retorno com melhor desempenho. O processamento de retorno (POST /api/v1/arquivos/cnab/retornos) ficou mais rápido. Reenviar o mesmo arquivo enquanto o primeiro envio ainda está em processamento passa a responder 409 com o código 7A31E5C2; depois do processamento, o reenvio continua respondendo 409 com o código D2691CCA. Processar retorno.

• Correção Protesto e abatimento repetidos no retorno. Arquivos com duas ocorrências de protesto para o mesmo boleto deixam de falhar no processamento, e ocorrências repetidas de protesto e abatimento no CNAB 240 passam a ser consideradas corretamente. No Santander, a baixa por protesto deixa de duplicar o protesto da mesma ocorrência. Pedidos de cancelamento ainda pendentes são preservados quando chega uma nova ocorrência. Processar retorno.

• Melhoria Header de Pix apenas quando há código. Nas respostas do plano Personalizado, o header X-BoletoCloud-Pix-Codigo-EMV deixa de ser enviado quando o código está ausente ou em branco. Vale para a criação do boleto, obtenção do PDF original e atualizado e consulta do status do registro. Criar boleto. Status do registro.

2026-09-03 versão 0.12.388

• Correção C6 pago sem lista de pagamentos. A conciliação do C6 deixa de registrar um novo pagamento quando o banco informa a cobrança como paga, mas devolve uma lista de pagamentos vazia. Consulta de situação.

2026-08-28 versão 0.12.387

• Correção Data de crédito do pagamento no C6. A data de crédito informada pelo banco passa a estar disponível em pagamento.dataCredito na consulta de situação dos boletos do C6. Consulta de situação.

2026-08-28 versão 0.12.386

• Correção Nome do arquivo de remessa do Daycoval. O arquivo de remessa do Daycoval gerado pela API passa a usar o prefixo cadastrado na conta em seu nome. Gerar remessa.

2026-07-24 versão 0.12.383

• Novidade Envelope de lote/carnê harmonizado entre criação e consulta. A resposta 201 da criação de batch e carnê agora inclui batch.total, e a consulta de situação do lote/carnê agora inclui batch.boletos[]. As duas respostas passam a ter a mesma estrutura de topo: token, tokenControleUsuario, total, boletos[] e titulos[]. A ordem das listas pode diferir entre a criação e a consulta: correlacione sempre pelo token, nunca pelo índice.

2026-07-22 versão 0.12.381

• Novidade Consulta de situação agregada do lote/carnê. GET /api/v1/batch/boletos/{token}/situacao e GET /api/v1/carnes/{token}/situacao devolvem a situação de todos os boletos do lote em uma única chamada — registro, pagamento, baixa, protesto e Pix por boleto, com cada item no mesmo contrato da consulta individual. Lote ou carnê que não existe para a sua conta responde 404 (código 7B41C2E9 no lote e 3F8A5D16 no carnê). Documentação.

• Novidade Token de controle no lote/carnê (idempotência em dois níveis). O envelope de criação aceita batch.tokenControleUsuario (protege o lote inteiro) além do tokenControleUsuario por boleto. Reenvio com o mesmo token de controle responde 409 com Location apontando a consulta de situação do lote existente — e GET /…/controle/{tokenControleUsuario}/situacao permite recuperar a criação após um timeout usando o seu identificador (404 = pode reenviar com segurança).

• Correção Desconto percentual na criação de boletos. O desconto percentual informado em descontoDetalhe, descontoDetalhe2 ou descontoDetalhe3 não era aplicado ao boleto. Corrigido: o percentual enviado passa a valer na criação individual e em lote. Campos de desconto.

2026-07-09 versão 0.12.380

• Correção Remessa CNAB 400 do Credisis. O número da parcela passa a ser preenchido com 01, evitando a rejeição por parcela zerada. A remessa também passa a incluir o prazo para protesto quando informado no boleto. Gerar remessa.

• Novidade Chave da NF-e na remessa do Sofisa. A remessa CNAB 400 do Sofisa passa a incluir a chave de acesso da nota fiscal informada no boleto. Gerar remessa. Campos do boleto.

2026-07-07 versão 0.12.379

• Novidade Dados de conferência na consulta de situação. A consulta de situação do boleto passa a trazer os dados de conferência da emissão — pagador (pagador.nome e pagador.cprf formatado), multa, juros e descontos — e a data em que o erro de Pix foi informado (pix.erro.informadoEm). Consulta de situação.

• Correção Documentação de boleto.juros: taxa diária. boleto.juros é uma taxa diária (percentual ao dia). A documentação dizia, por engano, “ao mês”; o comportamento da API não mudou. Exemplo: para cerca de 1% ao mês, envie 0.0333. Campos do boleto.

2026-07-03 versão 0.12.378

• Novidade Consulta de situação do boleto em JSON. GET /api/v1/boletos/{token}/situacao e, pelo seu identificador, GET /api/v1/boletos/controle/{tokenControleUsuario}/situacao devolvem registro, pagamento, baixa, protesto e Pix. Consulta de situação.

2026-06-08 versão 0.12.375

• Correção Registro online antes da remessa automática. Boletos emitidos pela API com registro online habilitado deixam de entrar na remessa automática antes da conclusão desse registro. Criar boleto.

• Correção Registro online na criação em lote. Boletos criados em lote pela API também deixam de entrar na remessa automática enquanto o registro online está pendente. Criar batch.

2026-05-28 versão 0.12.373

• Correção Documento do pagador no retorno do Cresol. O retorno CNAB 240 do Cresol deixa de falhar quando o CPF ou CNPJ do pagador vem preenchido com espaços à direita. Processar retorno.

• Correção Tratamento de rejeições na Cecred/Ailos. Respostas de erro do banco com campos adicionais deixam de impedir o tratamento da rejeição no registro online. Status do registro.

• Correção CPF e CNPJ com zeros à esquerda no Banco do Brasil. No registro online do Banco do Brasil, os documentos do pagador e do sacador avalista passam a preservar os zeros à esquerda. Criar boleto.

2026-04-20 versão 0.12.371

• Correção Endereço do beneficiário no PDF. O endereço do beneficiário volta a ficar legível no PDF do modelo padrão usado no plano Personalizado. Criar boleto.

2026-04-08 versão 0.12.369

• Correção Seu número no registro online do Banco do Brasil. Corrigidas rejeições do registro online relacionadas a acentos e caracteres não aceitos no documento do boleto, também chamado de seu número. Criar boleto. Campos do boleto.

• Correção Protesto no retorno do Santander. O processamento do retorno CNAB 240 do Santander passa a registrar o protesto informado pela ocorrência 23. Processar retorno.

2026-04-02 versão 0.12.368

• Correção E-mail do pagador no registro do C6. Quando o pagador tem múltiplos endereços de e-mail, o registro online do C6 passa a enviar um único endereço ao banco. Criar boleto.

• Correção Rejeição longa no registro do C6. A rejeição do registro online no C6 passa a ficar disponível no status do registro mesmo quando a mensagem devolvida pelo banco é longa. Status do registro.

2026-04-01 versão 0.12.367

• Correção Nome do pagador no registro do C6. Corrigidas rejeições do registro online do C6 relacionadas ao tamanho do nome do pagador. Criar boleto.

2026-03-23 versão 0.12.363

• Novidade Abatimento no Sicredi. PUT /api/v1/boletos/{token}/abatimento passa a aceitar contas Sicredi, além de Bradesco. A remessa CNAB 400 do Sicredi passa a incluir a ocorrência de abatimento. Conceder abatimento.

• Novidade Registro online do C6. Boletos emitidos pela API em contas C6 passam a poder ser registrados online. Criar boleto. Bancos suportados.

• Novidade Sofisa sem banco correspondente. Contas Sofisa sem correspondente passam a emitir boletos com nosso número, linha digitável e PDF próprios dessa modalidade. A remessa CNAB 400 passa a usar o formato correspondente, e o retorno identifica o boleto pelo nosso número do Sofisa. Criar boleto. Gerar remessa. Processar retorno.

• Correção Protesto e liquidação no retorno do Sisprime. O processamento do retorno CNAB 400 do Sisprime passa a reconhecer as ocorrências 15, 23 e 34, relacionadas a protesto e liquidação. Processar retorno.

• Correção Conciliação de boletos marcados como recebidos no Inter. A conciliação do Inter passa a registrar o pagamento de boletos que o banco informa como recebidos, inclusive quando ele não envia o valor total pago. Consulta de situação.

2026-03-05 versão 0.12.355

• Correção Título pago no retorno do Inter. O processamento do retorno CNAB 400 do Inter deixa de falhar ao processar títulos pagos em arquivos sem valor de juros. Processar retorno.

2026-02-09 versão 0.12.351

• Novidade Listar remessas por conta e data. GET /api/v1/arquivos/cnab/remessas, com os parâmetros conta e data, lista as remessas da conta naquela data e está disponível no plano Personalizado. A resposta inclui remessas.meta e remessas.arquivos[], com token, dataHoraCriacao, numeroOrdemNoDia, numeroSequencial e quantidadeDeBoletos. Sem remessas na data, responde 200 com corpo JSON null. Listar remessas.

• Correção Número da nota fiscal vazio. Na emissão de boletos, o número da nota fiscal, quando informado, deixa de aceitar uma string vazia (""). Campos do boleto.

• Melhoria Link de documentação nos erros. O link de documentação devolvido na causa dos erros da API passa a apontar para https://developers.boleto.cloud. Status e erros.