Guia · API

API de boleto: como emitir boleto programaticamente

Crie a cobrança, receba código de barras, linha digitável e Pix do boleto, confirme por webhook. R$ 2,50 só no pago.

Falar com o timeGateway de boleto

O que é uma API de boleto

API de boleto é o jeito programático de emitir cobrança bancária: seu sistema faz uma requisição HTTP e recebe os dados pra exibir ou enviar ao cliente — sem emitir manualmente no banco. Na AbacatePay isso passa pelo checkout transparente com method: "BOLETO".

API de boleto × gateway de pagamento

O gateway de boleto é o produto (painel, link, checkout, conciliação). A API de boleto é a camada pra integrar no seu backend. Quem já usa API Pix segue o mesmo padrão de transparente + webhook.

Passo a passo

Como emitir boleto via API

  1. Use a chave de teste (sandbox) ou a chave de produção no Bearer token.
  2. POST /transparents/create com method: "BOLETO".
  3. Envie data.amount, data.customer.name e data.customer.taxId.
  4. Exiba código de barras, linha digitável e o Pix do boleto na resposta.
  5. Escute o webhook transparent.completed quando pagar.

Gateway de boleto · API Pix · Docs boleto · Sandbox

curl -X POST https://api.abacatepay.com/v2/transparents/create \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "BOLETO",
    "data": {
      "amount": 5000,
      "customer": {
        "name": "Cliente Exemplo",
        "taxId": "123.456.789-09"
      }
    }
  }'

Juros e multa

Os campos opcionais interest e fine permitem cobrar juros e multa por atraso. Detalhes na documentação de boleto transparente.

Boleto + Pix no mesmo código

Todo boleto da AbacatePay já traz Pix impresso (boleto híbrido / boleto com Pix). Se o cliente pagar pelo Pix, a taxa é R$ 0,80 e o saldo cai na hora; pelo código de barras, R$ 2,50 em até D+3 úteis. Compare meios em Pix ou boleto, veja o gateway Pix e as taxas em /pricing.

Checkout · Link de pagamento · Gateway gratuito · Como escolher gateway

Falar com o time

Dúvidas sobre API de boleto

Emissão, webhook, taxas, sandbox e diferença para o gateway.

O que é uma API de boleto?

É a interface programática pra emitir boletos: você envia valor e dados do cliente e recebe código de barras, linha digitável e, na AbacatePay, o Pix do boleto — depois confirma o pagamento por webhook.

Qual a diferença entre API de boleto e gateway de pagamento?

A API é o caminho do código. O gateway de boleto (abacatepay.com/boleto) inclui painel, checkout e link. Os dois usam a mesma cobrança por baixo.

Quais campos são obrigatórios?

Em data: amount (centavos), customer.name e customer.taxId. O method é BOLETO. Juros (interest) e multa (fine) são opcionais.

Quanto tempo o boleto leva para compensar?

Pago pelo código de barras, em até D+3 (dias úteis). Pago pelo Pix impresso no boleto, na hora.

Como recebo notificação quando o boleto for pago?

Via webhook transparent.completed. Configure o endpoint e trate com idempotência — o mesmo evento pode ser reenviado.

Qual é a taxa para emitir boleto via API?

R$ 2,50 por boleto pago. Gerar é grátis. Se pagar pelo Pix do boleto, vale R$ 0,80.

Posso testar no sandbox?

Sim. Com a chave de teste na mesma URL da API. Veja abacatepay.com/blog/como-testar-gateway-sandbox-abacatepay.

Preciso de CNPJ?

Sim. MEI serve.

Falar com o time

Sem mensalidade. Aprovação não leva semanas.

Emita boleto pela API hoje

Conta grátis, modo de teste na mesma URL e documentação com exemplos.

Falar com o time

Sem mensalidade. Aprovação não leva semanas.

Ilustração renascentista com anjos e um abacate numa concha