Quando usar
Faturas e mensalidades
Planos de assinatura, condomínios, mensalidades escolares — qualquer cobrança recorrente com data de vencimento definida.
Substituição de boleto
Migre cobranças que hoje geram boleto para Pix com vencimento, mantendo multa e juros por atraso e desconto por antecipação.
Passo a passo
Crie a cobrança com vencimento
Os campos obrigatórios são Note que o
correlationId, amount, dueDate, e os objetos payer e address com seus dados completos.expiresAt é calculado automaticamente com base no dueDate e no maxDaysOverdue (padrão de 30 dias após o vencimento). O pagamento ainda será aceito após o dueDate, mas com acréscimo de juros e multa, se configurados.Configure encargos e descontos (opcional)
O objeto
taxes é onde você define o comportamento financeiro da cobrança. Todos os campos são opcionais entre si — use apenas os que fazem sentido para o seu caso.| Campo | Quando é aplicado | Tipos aceitos |
|---|---|---|
rebate (abatimento) | Sempre, independente da data | FIXED_AMOUNT, PERCENTAGE |
discount (desconto) | Apenas se pago antes do vencimento | FIXED_AMOUNT, PERCENTAGE |
interest (juros) | Por dia/mês/ano após o vencimento | FIXED_AMOUNT_CALENDAR_DAY, PERCENTAGE_PER_DAY_CALENDAR_DAY, PERCENTAGE_PER_MONTH_CALENDAR_DAY, PERCENTAGE_PER_YEAR_CALENDAR_DAY |
fine (multa) | Aplicada uma vez, após o vencimento | FIXED_AMOUNT, PERCENTAGE |
rebateAmount reduz o valor base da cobrança independentemente de quando o pagamento ocorre. discountAmount só é aplicado se o pagamento vier antes do dueDate.Exiba o QR Code para o pagador
A resposta inclui tudo que você precisa para apresentar a cobrança:
payloadPix— o “Pix Copia e Cola”.qrCodeImageBase64— imagem pronta do QR Code, quandoformatResponseéPAYLOAD_AND_QRCODE.dueDateeexpiresAt— exiba o vencimento para o pagador deixar claro o prazo sem encargos.
Receba a confirmação via Webhook
O fluxo é idêntico aos outros modelos: quando o pagamento é liquidado, a API dispara o evento
PIX_RECEIVED com o correlationId da cobrança.Veja Processando a confirmação via Webhook para o passo a passo completo.Consulte o status quando necessário
Consulte o estado da cobrança pelo
correlationId ou transactionId:cURL
Desconto escalonado por data
Em vez de um desconto único, você pode oferecer até 3 faixas de desconto com datas diferentes, incentivando o pagamento cada vez mais antecipado. Nesse caso, usediscountsDueDate no lugar de discountAmount — os dois campos são mutuamente exclusivos.
dueDate), incidem juros e multa.
Referência da API
Criar
POST /pix/qrcode/due-dateConsultar
GET /pix/qrcode/due-date/:idCancelar
PATCH /pix/qrcode/due-date/:id/cancel
