Pular para o conteúdo principal

Boleto Bancário

Quick Reference

WhatPagamentos via Boleto Bancário
WhyBoleto offline aceito em qualquer banco, caixa eletrônico ou app bancário no Brasil — alcança a população desbancarizada
Reading Time10 min
DifficultyBeginner
PrerequisitesAutenticação → Ambiente

O que é Boleto Bancário

O Boleto é um título de cobrança bancária regulamentado pelo Banco Central do Brasil. O comerciante gera um boleto com código de barras e data de vencimento; o cliente paga em qualquer agência bancária, caixa eletrônico, casa lotérica ou app bancário. A liquidação ocorre via CIP (Câmara Interbancária de Pagamentos) em 1 a 3 dias úteis.

CaracterísticaDetalhe
MercadoBrasil
MoedaBRL
LiquidaçãoD+1 a D+3
ChargebacksNenhum — pagamento push
Validade padrão3 dias (configurável)

Como funciona

1

Comerciante cria a cobrança

Seu servidor chama POST /api/v1/bank/wallet/charge/ com type_charge: "boleto".

2

A55 gera o boleto

A API retorna uma URL do PDF (boleto_url) e a linha digitável do código de barras (barcode).

3

Cliente paga

O cliente paga em uma agência bancária, caixa eletrônico, casa lotérica ou app bancário usando o código de barras.

4

Liquidação via CIP

O pagamento é confirmado pela CIP e a A55 envia um webhook com status: "paid".


Fluxo de pagamento


Ciclo de vida do Boleto

StatusDescrição
issuedBoleto gerado; aguardando pagamento
pendingRegistrado no banco; aguardando pagamento do cliente
paidPagamento confirmado via CIP
canceledExpirado ou cancelado antes do pagamento
errorErro na geração ou processamento

Criar uma cobrança por Boleto

POST/api/v1/bank/wallet/charge/Bearer TokenCriar um pagamento via Boleto

Corpo da requisição

CampoTipoObrigatórioDescrição
type_chargestringSimDeve ser "boleto"
currencystringSim"BRL"
installment_valuenumberSimValor em BRL (ex.: 150 para R$150)
installment_countnumberSimSempre 1 para Boleto
payer_tax_idstringSimCPF (11 dígitos) ou CNPJ (14 dígitos)
payer_namestringSimNome completo do pagador
due_datestringSimData de vencimento no formato ISO 8601
descriptionstringNãoDescrição do pedido exibida no boleto
curl -X POST https://core-manager.a55.tech/api/v1/bank/wallet/charge/ \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"wallet_uuid": "00000000-0000-0000-0000-000000000000",
"merchant_id": "11111111-1111-1111-1111-111111111111",
"payer_name": "Maria Santos",
"payer_email": "maria.santos@example.com",
"payer_tax_id": "12345678901",
"payer_cell_phone": "+5511988887777",
"installment_value": 250,
"installment_count": 1,
"items": [{"name":"Annual Plan","quantity":1,"total_amount":250,"unit_amount":250,"sku":"PLAN-001","code":"AP001"}],
"payer_address": {"street":"Rua Augusta","address_number":"500","complement":"Sala 12","neighborhood":"Consolação","city":"São Paulo","state":"SP","postal_code":"01304-001","country":"BR"},
"currency": "BRL",
"due_date": "2026-12-31T23:59:59Z",
"description": "Annual subscription plan",
"type_charge": "boleto",
"webhook_url": "https://yoursite.com/webhook",
"redirect_url": "https://yoursite.com/confirmation"
}'

Exemplo de resposta

{
"charge_uuid": "a3b1c2d4-5678-9abc-def0-1234567890ab",
"currency": "BRL",
"type": "boleto",
"status": "issued",
"boleto_url": "https://pay.a55.tech/boleto/a3b1c2d4-5678-9abc-def0-1234567890ab.pdf",
"barcode": "23793.38128 60000.000003 00000.000400 1 84340000025000",
"due_date": "2026-12-31",
"charge_payment_url": "https://pay.a55.tech/charge/a3b1c2d4-5678-9abc-def0-1234567890ab"
}
CampoDescrição
boleto_urlLink direto para o PDF do boleto para download ou impressão
barcodeLinha digitável — o cliente pode digitá-la em qualquer app bancário
due_dateData de vencimento após a qual o boleto não pode mais ser pago
charge_payment_urlPágina de pagamento hospedada com os detalhes do boleto

Vencimento

O vencimento padrão do boleto é de 3 dias úteis. Você pode configurar isso através do campo due_date. Após o vencimento, o boleto é automaticamente cancelado e um webhook com status: "canceled" é enviado.

Tentativas com boleto vencido

Clientes ainda podem tentar pagar um boleto vencido em uma agência física. O banco rejeitará o pagamento, mas a experiência do cliente será ruim. Defina uma janela de vencimento razoável.


Prazo de liquidação

CenárioLiquidação
Boleto padrãoD+1 a D+3 dias úteis
Boleto registradoD+1
Como funciona a liquidação pela CIP

Quando o cliente paga o boleto, o banco emissor notifica a CIP (Câmara Interbancária de Pagamentos). A CIP processa a liquidação interbancária em ciclos de lote e notifica a A55. A A55 então dispara o webhook paid para o seu endpoint. O ciclo completo leva de 1 a 3 dias úteis, dependendo do banco e do horário do pagamento.


Erros comuns

ErroCausaSolução
invalid_tax_idCPF/CNPJ falhou na validaçãoVerifique o CPF (11 dígitos) ou CNPJ (14 dígitos) do pagador
invalid_due_datedue_date está no passadoDefina uma data futura, mínimo 1 dia útil à frente
amount_below_minimumValor abaixo do mínimo do provedorVerifique o valor mínimo do boleto (geralmente R$5,00)
boleto_generation_failedBanco rejeitou o registroTente novamente; se persistir, verifique os dados do pagador e entre em contato com o suporte