Pré-requisitos, fluxo, e passo à passo de como simular e antecipar seus recebíveis.
Importante:A antecipação ocorre por UR (Unidade de Recebível), e não por parcela.
Como os recebíveis são registrados em REGISTRADORES, qualquer IF pode realizar a antecipação e agravamar as URs como garantia, reduzindo o saldo a receber dentro da iugu.UR é composta pelo valor total da fatura, independente da quantidade de parcelas.
Validações iniciais (pré-requisitos):
-
A conta iugu deve ter a função Antecipação habilitada.
-
Deve-se atentar à disponibilidade da função:
Horários de AntecipaçãoDias úteis, de 9h05 às 18h50.
Fluxo:
Para efetuar uma Antecipação via API, siga a seguinte ordem de requisições para as Endpoints listadas:
-
Acesse o endpoint 'Criar Simulação de Recebíveis' e crie uma Simulação (POST).
-
O status da Simulação pode ser recebido via webhook, como também pode ser consultado a qualquer momento através do endpoint 'Verificar Status da Simulação' (GET).
Atenção: A simulação possui um prazo de expiração de 30 minutos (contabilizando o tempo desde a sua solicitação). -
Ao checar o status de uma Simulação, os status 'processing' ou 'done' serão retornados.
-
Para finalmente solicitar uma Antecipação através do endpoint 'Aprovar Antecipação' (POST), será necessário ter recebido o webhook informando que a simulação foi concluída, ou uma resposta com status 'done' do endpoint 'Verificar Status da Simulação'.
A Antecipação será criada a partir dos valores informados na resposta do progresso da simulação. -
Para ser notificado ao finalizar a Antecipação, utilize o webhook de Status de Antecipação. Você também pode consultar o status da Antecipação (endpoint 'Verificar Status da Antecipação'), lembrando que é necessário ter aprovado uma Antecipação anteriormente (endpoint 'Aprovar Antecipação').
-
Para gerar uma nova simulação, aguarde a finalização da simulação anterior (done) e então envie uma nova simulação com o valor desejado. Apenas UMA simulação/antecipação pode ser executada por vez.
Extrato Consolidado de LiquidadosUtilize também nossa endpoint de Extrato Consolidado de Liquidados, que retorna o extrato de transações liquidadas e pagamentos pendentes/efetivados, para facilitar conciliações e relatórios.
Apenas disponível para o ambiente produção.
