Quando usar
Adesão sem cobrança inicial
Assinaturas com período de teste, matrículas ou contas de consumo, em que a primeira cobrança vem depois.
Adesão em tela ou papel
Exiba o QR Code no checkout, em um e-mail, na fatura impressa ou no balcão. O Pix Copia e Cola funciona do mesmo jeito.
Passo a passo
1
Defina o identificador da recorrência
Cada recorrência tem um
recurrenceId de 29 caracteres. Se você não enviar, a API gera um, mas não o devolve na resposta. Por isso, recomendamos gerar o seu e guardá-lo antes de criar o QR Code. Veja o formato do recurrenceId.2
Crie o QR Code
201 Created. Os dados do recebedor (nome, CNPJ e instituição) vêm da sua conta. Não é preciso enviá-los.3
Exiba o QR Code para o pagador
Mostre a imagem de
qrCodeImageBase64 e ofereça o payloadPix como Pix Copia e Cola. O pagador lê o código, vê o contrato, a periodicidade e o valor, e autoriza no app do banco dele.4
Acompanhe as cobranças
Com a autorização aprovada, a Delfinance envia automaticamente a cobrança de cada ciclo, entre 10 e 2 dias antes do vencimento. Veja Cobranças recorrentes.
Valor fixo ou variável
Escolha um dos dois campos. Enviar os dois juntos retorna400.
Sem nenhum dos dois, a recorrência tem valor variável e o pagador escolhe o valor máximo livremente.
Periodicidade e datas
recurrenceStartDateé a data prevista da primeira cobrança, no formatoYYYY-MM-DD.recurrenceEndDateé opcional. Sem ela, a recorrência não tem prazo para acabar. Se informar, deixe alguns dias de folga depois do último vencimento, para caber eventuais retentativas.
Devedor e pagador
Odebtor é a pessoa ou empresa a quem o contrato se refere: o assinante, o aluno, o titular da conta de luz. Ele pode ser diferente de quem paga. Exemplo: um responsável (pagador) autoriza a mensalidade escolar de um aluno (devedor).
O
beneficiaryConciliationId é obrigatório, mas hoje ele não volta em nenhuma consulta nem webhook. Use o recurrenceId para conciliar a recorrência no seu sistema.Referência da API
Criar QR Code de autorização
POST /baas/api/v1/pix/qrcode/recurrences
