Agendamentos e retentativas
Com a recorrência authorized, cada cobrança é um agendamento. O banco do pagador confirma e debita na data. Agendar e pedir retentativa movem dinheiro: são operações financeiras e só aceitam credencial M2M com o escopo pix.automatic. Token de usuário do painel recebe 403.
Agendar uma cobrança
Cada ciclo aceita um agendamento ativo; outro no mesmo ciclo responde 409 automatic_pix_scheduling_conflict. Recorrência que não está authorized responde 409 automatic_pix_recurrence_not_authorized.
A resposta é 201 com o schedulingId. Depois vêm os webhooks:
pix.automatic.scheduling.confirmed, quando o banco do pagador confirma. Se recusar, sai.rejected; se não responder a tempo,.failed.- Na data,
pix.automatic.settlement.completedepix.in.completed, com o mesmoendToEndId. Não some os dois. - Se o dinheiro não entrar, sai
pix.automatic.settlement.failedcomsettlementIdesettlementStatus(insufficient_balance,not_settledounot_settled_with_error).
Consultar e listar
Leituras ao vivo. O agendamento traz status, history, endToEndId e, quando existe, settlement com settlementId, status e settledAt. Retentativas aparecem na mesma lista com purpose: retry.
Adiar
Só enquanto o agendamento está created, antes de seguir para o banco do pagador; depois disso a resposta é 409 automatic_pix_scheduling_conflict. O banco do pagador confirma a nova data. Adiar não é operação financeira: o painel também pode.
Retentativa
Vale para recorrência criada com paymentRetry: true, depois de pix.automatic.settlement.failed.
O GET devolve suggestedDates, remainingAttempts, maxRetryDates e windowEnd. A retentativa precisa cair depois do vencimento original, em até 7 dias corridos e no mesmo ciclo.
De 1 a 3 datas, das sugeridas. Cada uma vira um agendamento com purpose: retry e segue o mesmo fluxo de webhooks. Retentativa não permitida (sem paymentRetry, liquidação já feita, tentativa em andamento no dia ou datas esgotadas) responde 409 automatic_pix_retry_not_allowed.