Skip to main content
O boleto bancário é uma cobrança com data de vencimento que o cliente paga pelo código de barras, pela linha digitável ou pelo Pix que vem no próprio boleto. Na AbacatePay, você gera boletos no checkout, no link de pagamento e no checkout transparente.

Quando usar o boleto

  • Cliente sem cartão ou que prefere pagar depois, dentro de um prazo.
  • Faturas e mensalidades com data certa, em que vale cobrar juros e multa pelo atraso.
  • Empresas que pagam por boleto no fluxo de contas a pagar.
Se você precisa da confirmação na hora, prefira o Pix. Para parcelar, use o cartão de crédito. A comparação das três formas está em Quando usar o Pix.

Como funciona o boleto

  • Valor mínimo: R3,00(‘300‘centavos).Abaixodisso,aAPIresponde‘OvalormıˊnimoparaboletoeˊR 3,00 (`300` centavos). Abaixo disso, a API responde `O valor mínimo para boleto é R 3,00 (300 centavos)`. No checkout, o mínimo vale para o total dos itens.
  • Dados de quem paga: o boleto exige nome e CPF/CNPJ. No checkout e no link, o cliente preenche. No checkout transparente, você envia em customer.
  • Liberação: o boleto precisa estar liberado na sua conta. Sem isso, a API responde BOLETO is not available for this store.
  • Sem reembolso: boleto pago não pode ser reembolsado. Veja Reembolsos.

Vencimento do boleto

O vencimento vem do campo dueDate, no formato AAAA-MM-DD (ex.: "2026-12-15").
  • Sem dueDate: o boleto vence em 3 dias úteis, contados a partir do momento em que ele é gerado.
  • Data no passado: recusada com dueDate cannot be in the past.
  • Prazo máximo: 365 dias. Depois disso, a API responde dueDate cannot be more than 365 days in the future.
  • Formato errado: recusado com dueDate must be a valid date in YYYY-MM-DD format.
  • Hora do vencimento: o boleto vence no fim do dia, no horário de Brasília. A resposta traz esse momento em expiresAt.
No checkout e no link de pagamento, dueDate exige "BOLETO" em methods. Sem ele, a API responde 400 com dueDate requires BOLETO in methods. Isso vale também quando methods é omitido, porque o padrão é Pix e cartão. O dueDate de um checkout ou de um link vale para todo boleto gerado nele. Num link de pagamento, todos os clientes recebem boletos com a mesma data de vencimento. Depois dessa data, o link não gera mais boleto, e o cliente só consegue pagar pelas outras formas que o link aceita. Para um link que fica no ar por muito tempo, deixe dueDate de fora: cada boleto vence 3 dias úteis depois de gerado.

Depois do vencimento

  • Sem juros nem multa: o boleto expira (EXPIRED) e não aceita mais pagamento.
  • Com juros ou multa: o boleto continua aberto depois do vencimento, e o cliente paga com o acréscimo. Veja Juros e multa no boleto.

Pix no boleto

Todo boleto vem com um Pix para o mesmo valor. O cliente escolhe como pagar:
  • Pelo Pix do boleto: a confirmação sai em segundos, e vale a taxa de Pix.
  • Pelo código de barras ou pela linha digitável: vale a taxa de boleto, e a confirmação depende da compensação bancária, que leva até 3 dias úteis.
A taxa só é cobrada quando o boleto é pago. Os valores estão em Taxas.

Código de barras e linha digitável

A cobrança de boleto traz estes campos: Para mandar o boleto por e-mail ou WhatsApp, envie a url ou a linha digitável.

Pelo dashboard

  1. Em Sua Loja → Cobranças, clique em Criar cobrança. Para um link que vários clientes pagam, use Sua Loja → Links de pagamento → Criar link de pagamento.
  2. Em Métodos de pagamento, marque Boleto. A opção só aparece se o boleto estiver liberado na sua conta.
  3. Escolha produtos que somem pelo menos R$ 3,00.
  4. Mande o link ao cliente. Ele escolhe Boleto, preenche os dados e clica em Imprimir / Salvar Boleto.
Pelo dashboard, o boleto vence no prazo padrão de 3 dias úteis. Outra data de vencimento, juros e multa só pela API.

Pela API

Inclua "BOLETO" em methods e, se quiser, a data de vencimento. Os campos são os mesmos em Criar um checkout e Criar um link de pagamento.
A resposta e a consulta do checkout trazem dueDate (ou null, quando não foi definido).

No checkout transparente

Chame POST /v2/transparents/create com method: "BOLETO":
A resposta traz o boleto e o Pix dele:
Para consultar um boleto, use GET /v2/transparents/get?id=bole_... ou Listar cobranças. A rota /transparents/check aceita só Pix.

Notificações

O conteúdo de cada evento está em eventos de checkout e eventos do checkout transparente. Não há evento de vencimento: use expiresAt ou consulte o status. Para configurar, veja Webhooks.

Testar no Modo Teste

  • Checkout e link de pagamento: escolha Boleto na tela de pagamento e clique em Simular Pagamento.
  • Checkout transparente: a API cria o boleto com código de barras e linha digitável de teste, que não pagam nada. A rota de simulação existe só para Pix.
Veja Modo Teste.

Perguntas frequentes

R$ 3,00 (300 centavos), no checkout, no link de pagamento e no checkout transparente.
3 dias úteis a partir do momento em que o boleto é gerado. Pela API, você define outra data com dueDate, até 365 dias à frente.
Não. Se precisar devolver o dinheiro, mande um Pix ao cliente pelo Enviar Pix.
Só se o boleto tiver juros ou multa. Sem eles, o boleto expira no vencimento. Veja Juros e multa no boleto.
Não. Gere um boleto novo com a data certa.
barCode é o código de barras (44 dígitos). identificationNumber é a linha digitável (47 dígitos), o número que o cliente digita no app do banco.
Não. A taxa só é cobrada quando o boleto é pago. Se o cliente pagar pelo Pix do boleto, vale a taxa de Pix.