Prepare o contrato e o pagador
Confira o valor de cada parcela e o total combinado com o cliente. Cadastre o pagador com documento válido e defina uma descrição que permita reconhecer o contrato.
Defina as parcelas
Em Novo carnê, informe o valor por parcela, a quantidade e o primeiro vencimento. Pela API, os campos são installmentAmountCents, installmentCount e firstDueDate. O valor informado é por parcela; não envie o total do contrato nesse campo.
Confira o calendário antes de compartilhar
Revise o conjunto de vencimentos retornado, especialmente quando o primeiro vencimento está no final de um mês. Não presuma uma regra de feriado ou de mês curto sem conferir o comportamento efetivo da implantação.
Acompanhe cada parcela
Cada parcela aponta para uma cobrança. O pagamento de uma não quita outra. O cliente abre o carnê e realiza o Pix de cada parcela; esse produto não debita automaticamente na conta bancária.
Em integração, guarde o plano e as cobranças retornadas. Use paymentPlanId e installmentNumber dos eventos para relacionar cada pagamento ao contrato.
Confira os campos e regras atuais antes de integrar. Seu cliente sempre paga a cobrança por Pix.
Abrir documentação ↗