Boleto

Gere boletos bancários registrados, pagáveis em qualquer banco, app ou lotérica

O boleto é uma boa alternativa para clientes que não usam PIX, para pagamentos agendados ou cobranças com vencimento futuro.

Como funciona

Você gera o boleto

Chama o endpoint de transações com paymentMethod: "boleto" e o valor da cobrança.

Recebe os dados de pagamento

A resposta traz o link do PDF, o código de barras e a linha digitável.

Cliente paga

O cliente paga escaneando o código de barras ou digitando a linha digitável em qualquer banco, app bancário ou lotérica.

Confirmação após compensação

Diferente do PIX, a compensação bancária do boleto leva algum tempo. Assim que ela ocorre, você recebe a confirmação via webhook.

Exemplo rápido

curl -X POST 'https://api.velfy.com/api/v1/transactions' \
  -u "sk_xxx:pk_xxx" \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentMethod": "boleto",
    "amount": 25000,
    "boleto": { "expiresInDays": 3 },
    "customer": {
      "name": "Maria Souza",
      "email": "maria@example.com",
      "document": { "type": "cpf", "number": "98765432100" }
    },
    "items": [
      { "title": "Serviço Y", "unitPrice": 25000, "quantity": 1, "tangible": false }
    ]
  }'

A resposta traz boleto.url (PDF), boleto.barcode e boleto.digitableLine — disponibilize um desses para o cliente pagar.

Ciclo de vida da cobrança

Status	O que significa
`pending`	Aguardando pagamento — disponibilize o boleto para o cliente
`paid`	Pagamento compensado — libere o produto/serviço
`refunded`	Valor devolvido ao cliente

Boas práticas

Escolha um boleto.expiresInDays (1 a 90) compatível com o prazo do seu produto/serviço
Lembre o cliente que a compensação do boleto pode levar até alguns dias úteis
Use externalRef para relacionar a cobrança com o pedido no seu sistema

Visão Geral

Autenticação

Métodos de Pagamento

Webhooks

Boleto

Boleto

Como funciona

Exemplo rápido

Ciclo de vida da cobrança

Boas práticas

Próximos passos

Referência técnica

PIX

​Boleto

​Como funciona

​Exemplo rápido

​Ciclo de vida da cobrança

​Boas práticas

​Próximos passos

Referência técnica

PIX

Boleto

Como funciona

Exemplo rápido

Ciclo de vida da cobrança

Boas práticas

Próximos passos