Skip to main content

Saque Recorrente

Time de Plataforma

Agora é possível agendar saques automáticos e periódicos para uma chave PIX de destino, sem precisar disparar manualmente um saque a cada ciclo.

Ao criar um saque recorrente, a API gera automaticamente todos os agendamentos com base na frequência (a cada X dias/meses, ou em um dia fixo do mês) e na duração informadas. Cada agendamento é processado individualmente, na sua data prevista, como um saque comum.

Novos endpoints

MétodoEndpointDescrição
POST/recurring-withdrawalCria um saque recorrente
GET/recurring-withdrawalLista saques recorrentes
GET/recurring-withdrawal/{id}Busca um saque recorrente
GET/recurring-withdrawal/{id}/schedulingsLista os agendamentos gerados
PUT/recurring-withdrawal/{id}/cancelCancela um saque recorrente ativo

Confira a documentação completa em Saque Recorrente.

Versão da documentação: 2.1.0