Integração Rápida
API REST moderna com autenticação HTTP Basic. Comece a emitir boletos em minutos com exemplos de código em 10 linguagens.
Documentação da API Boleto Cloud
Emita boletos bancários com Pix via API REST. Integração simples, registro automático e suporte aos principais bancos do Brasil. Comece testando no plano grátis.
Por que usar a API Boleto Cloud?
Seção intitulada “Por que usar a API Boleto Cloud?”Registro Automático
Boletos registrados automaticamente via API bancária ou arquivo CNAB. Sem intervenção manual.
Boleto + Pix
QR Code Pix integrado ao boleto. Seu cliente escolhe como pagar — você recebe de qualquer forma.
Principais Bancos
Suporte a Banco do Brasil, Bradesco, Caixa, Itaú, Santander, Sicoob, Sicredi, C6 Bank, Banco Inter e outros.
Endpoints Principais
Seção intitulada “Endpoints Principais”POST /boletosCria um boleto e retorna o PDF pronto na resposta. Ideal para emissão sob demanda.
POST /carnesCria múltiplos boletos com layout de 3 por página. Perfeito para parcelamentos e mensalidades.
POST /batch/boletosEmite até 300 boletos em uma única requisição com layout de 1 por página.
POST /arquivos/cnab/remessasPOST /arquivos/cnab/retornosGere remessas e processe retornos no padrão CNAB 240 e 400.
Comece em 4 Passos
Seção intitulada “Comece em 4 Passos”1. Crie sua Conta
Cadastre-se gratuitamente e obtenha suas credenciais de API para o ambiente Sandbox.
2. Configure o Banco
Cadastre sua conta bancária e configure os parâmetros de emissão conforme seu convênio.
3. Emita seu Primeiro Boleto
Faça sua primeira chamada à API no Sandbox usando os exemplos de código disponíveis.
4. Vá para Produção
Após validar sua integração no Sandbox, altere a URL base para o ambiente de Produção.
Guia Rápido da Documentação
Seção intitulada “Guia Rápido da Documentação” Visão Geral da API Entenda a estrutura da API: URLs, autenticação, formatos e convenções.
Autenticação Configure o HTTP Basic Auth com sua API Key para autenticar requisições.
Campos do Boleto Referência completa de todos os campos disponíveis na criação de boletos.
Status e Erros Códigos HTTP, estrutura de erros e como tratar problemas na integração.
Operações do Ciclo de Vida
Seção intitulada “Operações do Ciclo de Vida”Após criar um boleto, você pode gerenciá-lo através de diversos endpoints:
| Operação | Endpoint | Descrição |
|---|---|---|
| Criar Boleto | POST /boletos | Emite boleto e retorna PDF |
| Segunda Via | GET /boletos/{token} | Obtém PDF do boleto existente |
| Alterar Vencimento | PUT /boletos/{token}/vencimento | Prorroga a data de vencimento |
| Conceder Abatimento | PUT /boletos/{token}/abatimento | Aplica desconto no valor |
| Baixar/Cancelar | PUT /boletos/{token}/baixa | Cancela o boleto no banco |
| Status do Registro | GET /boletos/{token}/registro | Verifica se foi registrado |
Ambientes Disponíveis
Seção intitulada “Ambientes Disponíveis”| Ambiente | URL Base | Uso |
|---|---|---|
| Sandbox | https://sandbox.boletocloud.com/api/v1 | Desenvolvimento e testes |
| Produção | https://app.boletocloud.com/api/v1 | Emissão real de boletos |
Precisa de Ajuda?
Seção intitulada “Precisa de Ajuda?” FAQ Respostas para as dúvidas mais frequentes sobre a API.
Suporte Técnico Entre em contato com nossa equipe para resolver problemas.