Boleto

O Boleto permite que você gere cobranças através de boletos bancários registrados. Ideal para clientes que não utilizam PIX, pagamentos programados, recorrências simples ou cobranças com vencimento futuro. O boleto pode ser pago em bancos, lotéricas ou internet banking até a data de vencimento.

🚀 Como Funciona

O Boleto funciona através da criação de um título de cobrança vinculado ao CPF ou CNPJ do pagador. Após a geração, um boleto bancário é criado e disponibilizado em formato PDF e linha digitável para pagamento.

📱 Boleto emitido

Você gera um boleto com valor específico através da API

💳 Cliente Paga

Cliente escaneia o codigo de barras apresentando no PDF utilizando o app do banco

⚡ Confirmação em instantes

Você recebe confirmação por email assim que o pagamento for validado

💰 Valor Disponível

Valor fica disponível imediatamente em sua conta

🛠️ Implementação Rápida

1. Gerar boleto

⚠️ Validação do valor total da transação

O campo amountInCents enviado fora do array items representa o valor total da cobrança. Para que a requisição seja aceita, esse valor deve ser exatamente igual à soma do valor de cada item multiplicado por sua respectiva quantidade. Em outras palavras:

O total da transação precisa corresponder ao somatório de amountInCents × quantity de todos os itens informados.

curl -X POST 'https://api.avanttifinance.com/v1/boleto' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <seu_token>' \
  -d '{
  "amountInCents": 10000,
  "description": "Descrição opcional",
  "postbackUrl": "https://seu-dominio.com/webhook",
  "customer": {
    "name": "Nome do Cliente",
    "email": "cliente@email.com",
    "documentType": "cpf",
    "document": "12345678909",
    "phone": "+5511999999999"
  },
  "items": [
    {
      "title": "Produto",
      "tangible": true,
      "quantity": 1,
      "amountInCents": 10000
    }
  ],
  "seller": {
    "name": "Vendedor",
    "documentType": "cpf",
    "document": "12345678909"
  }
}'

2. Resposta com QR Code

{
  "success": true,
  "message": "Transação criada com sucesso",
  "data": {
    "id": "uuid-da-transacao",
    "boleto": {
      "url": "https://...",
      "barcode": "...",
      "digitableLine": "...",
      "dueAt": "2025-02-25T..."
    },
    "status": "pending",
    "fees": 0
  }

📊 Parâmetros Detalhados

Campos Obrigatórios

Campo	Tipo	Descrição
`amountInCents`	`number`	Valor em centavos (ex: 10000 = R$ 100,00)
`customer`	`object`	Dados do cliente pagador
`customer.name`	`string`	Nome completo do cliente
`customer.email`	`string`	Email do cliente
`customer.documentType`	`string`	Tipo do documento (`cpf` ou `cnpj`)
`customer.phone`	`string`	Telefone do cliente
`customer.billingAddress`	`object`	Endereço de cobrança
`customer.document`	`string`	Número do documento (apenas números)
`items`	`array`	Lista de itens da compra
`description`	`string`	Descrição da transação (máx. 140 caracteres)

Campos Opcionais

Campo	Tipo	Descrição
`postbackUrl`	`string`	URL específica para webhooks desta transação
`seller`	`object`	informações sobre vendedor

Exemplo Completo

{
  "amountInCents": 10000,
  "description": "Descrição opcional",
  "postbackUrl": "https://seu-dominio.com/webhook",
  "customer": {
    "name": "Nome do Cliente",
    "email": "cliente@email.com",
    "documentType": "cpf",
    "document": "12345678909",
    "phone": "+5511999999999"
  },
  "items": [
    {
      "title": "Produto",
      "tangible": true,
      "quantity": 1,
      "amountInCents": 10000
    }
  ],
  "seller": {
    "name": "Vendedor",
    "documentType": "cpf",
    "document": "12345678909"
  }
}

📡 Recebendo Confirmações

Via Webhook

Configure um webhook para receber confirmações automáticas:

{
  "id": "uuid-do-dispatch",
  "type": "transaction",
  "event": "transaction_paid",
  "scope": "postback",
  "transaction": {
    "id": "cuid_da_transacao",
    "amount": 10000,
    "status": "paid",
    "pix": null
  }
}

📋 Status das Transações

Status	Descrição	Próximo Passo
`pending`	Aguardando pagamento	Mostrar QR Code para cliente
`paid`	Pago com sucesso	Liberar produto/serviço
`canceled`	Cancelado	Gerar novo QR Code se necessário
`refunded`	Estornado	Valor devolvido ao pagador

🛡️ Boas Práticas

Segurança

🔒 Validação de Dados

Sempre valide CPF/CNPJ antes de enviar
Sanitize dados de entrada
Verifique valores mínimos e máximos
Use HTTPS obrigatoriamente

🔄 Idempotência

Use IDs únicos para cada transação
Implemente verificação de duplicatas
Mantenha referências internas
Trate reenvios de webhook adequadamente

📊 Monitoramento

Monitore taxa de conversão
Acompanhe tempos de pagamento
Verifique abandono de carrinho
Alerte sobre falhas de webhook

Performance

Timeout: Configure timeouts adequados para requisições
Retry: Implemente retry para chamadas falhadas
Batch: Agrupe operações quando possível

🎯 Próximos Passos

📝 Criar QR Code

Guia detalhado para criar QR Codes PIX

🔗 Configurar Webhooks

Configure notificações automáticas

🚀 PIX OUT

Aprenda a enviar transferências PIX

📊 Relatórios

Monitore suas transações

Comece Aqui

Autenticação

Pix In

Cartão de Crédito

Pix Out

Link de Pagamento

Transações e Reembolsos

Assinaturas

Gestão de Conta

Webhooks

Desenvolvedores

Boleto

🚀 Como Funciona

📱 Boleto emitido

💳 Cliente Paga

⚡ Confirmação em instantes

💰 Valor Disponível

🛠️ Implementação Rápida

1. Gerar boleto

⚠️ Validação do valor total da transação

2. Resposta com QR Code

📊 Parâmetros Detalhados

Campos Obrigatórios

Campos Opcionais

Exemplo Completo

📡 Recebendo Confirmações

Via Webhook

📋 Status das Transações

🛡️ Boas Práticas

Segurança

Performance

🎯 Próximos Passos

📝 Criar QR Code

🔗 Configurar Webhooks

🚀 PIX OUT

📊 Relatórios

​🚀 Como Funciona

📱 Boleto emitido

💳 Cliente Paga

⚡ Confirmação em instantes

💰 Valor Disponível

​🛠️ Implementação Rápida

​1. Gerar boleto

​⚠️ Validação do valor total da transação

​2. Resposta com QR Code

​📊 Parâmetros Detalhados

​Campos Obrigatórios

​Campos Opcionais

​Exemplo Completo

​📡 Recebendo Confirmações

​Via Webhook

​📋 Status das Transações

​🛡️ Boas Práticas

​Segurança

​Performance

​🎯 Próximos Passos

📝 Criar QR Code

🔗 Configurar Webhooks

🚀 PIX OUT

📊 Relatórios

🚀 Como Funciona

🛠️ Implementação Rápida

1. Gerar boleto

⚠️ Validação do valor total da transação

2. Resposta com QR Code

📊 Parâmetros Detalhados

Campos Obrigatórios

Campos Opcionais

Exemplo Completo

📡 Recebendo Confirmações

Via Webhook

📋 Status das Transações

🛡️ Boas Práticas

Segurança

Performance

🎯 Próximos Passos