Documentação
Guias de ImplementaçãoReferência da APIAPI StatusAjuda

Antecipação sob demanda

Suggest Edits

Antecipação sob demanda via API

O produto de antecipação, tem por objetivo, permitir que os parceiros possam antecipar suas transações (Crédito) que seriam liquidadas em uma data futura (D + Período acordado). Os parceiros terá disponível uma API onde poderão ser realizadas as antecipações.

No primeiro passo, o parceiro (Marketplace) deverá estar habilitado para realizar antecipações.

Uma vez que o Marketplace possa antecipar através da nossa API, será realizada uma solicitação de criação da antecipação, e na resposta da API será devolvido um identificador (ID da Antecipação).

Uma vez que o processo de simulação da antecipação for concluído, o mesmo passará pelo processo de aprovação, etapa onde as áreas de controle Financeiro irá ou não autorizar a simulação.

Após as autorização das áreas de controle, os recebíveis simulados que seriam pagos em datas futuras, passarão a ter data pagamento de acordo com dia da antecipação, uma vez que essas datas de pagamentos são alteradas, os recebíveis seguiram o fluxo de liquidação.

Solicitando Antecipação sob demanda

Criar um novo pedido de antecipação, que será posteriormente simulado e terá aprovação financeira para realizar a antecipação dos recebíveis.

ChaveValores
customer*
string		example: {{customer_id}}

ID do Seller que terá seus recebíveis antecipáveis.
prepayment_date*
string		($date)
example: 2018-01-19

Data para a qual os recebíveis serão antecipados. Caso não seja preenchido, é considerado D0.
min_transaction_date
string		($date)
example: 2018-01-19

Apenas considerar recebíveis de vendas realizadas após esta data (inclusive). Caso não seja preenchida, será considerada a data da venda mais antiga com recebíveis não liquidados.
max_transaction_date
string		($date)
example: 2018-01-19

Apenas considerar recebíveis de vendas realizadas até esta data (inclusive). Caso não seja preenchida, será considerado D-1. Este também é o valor máximo para este campo.
min_expected_date
string		($date)
example: 2018-01-19

Apenas considerar recebíveis cujo agenda original de liquidação seja após esta data (inclusive). Caso não seja preenchida, será considerado D+1 do campo "prepayment_date". Este também será o valor mínimo para este campo.
max_expected_date
string		($date)
example: 2018-01-19

Apenas considerar recebíveis cujo agenda original de liquidação seja até esta data (inclusive). Caso não seja preenchida, será considerada a data de liquidação do recebível mais tardio.
receivables
string		Lista de IDs de recebíveis que deverão ser incluídos na solicitação de antecipação

example: {{receivable_id}}

Poderá ser usada a informação que está no endpoint de Recebíveis aptos a antecipação para preencher a lista.
transactions
string		Lista de IDs de transações cujos recebíveis deverão ser incluídos na solicitação de antecipação

example: {{transaction_id}}
target_amount
integer		example: 500000

Valor alvo em centavos de Reais, para escolha dos recebíveis a antecipar mediante algoritmo de busca, que selecionam os recebíveis de forma incremental até atingir este valor alvo até o limite percentual da margem (campo "margin"). Recebíveis que façam o valor total de antecipação ultrapassar o valor alvo com a margem incluída, não serão incluídos na antecipação. Caso um recebível faça o valor da antecipação atingir o intervalo entre o valor alvo e a margem, o algoritmo é interrompido e a simulação é concluída com os recebíveis selecionados.
margin
number		($float)
example: 0.01

Margem para seleção de recebíveis caso seja solicitado o filtro de valor alvo (target_amount). Caso não seja preenchido, será considerado 0.01 (1%), isso significa que em caso de uma antecipação solicitada com target_amount de 500000 (R$5.000,00) e sem margem definida, o algoritmo selecionará recebíveis até atingir o valor de R$5.000,00, porém nunca ultrapassando o valor de R$5.050,00 (recebíveis que ultrapassariam este valor são descartados - pulados), mesmo que o valor final seja inferior ao valor alvo solicitado, a antecipação é considerada simulada e fica apta à aprovação.
order
string		Indica a prioridade de seleção dos recebíveis na antecipação por valor alvo. Como os recebíveis são selecionados um por um até atingirem o valor alvo, poderá utilizar este campo para forçar uma seleção dos recebíveis que estejam vencendo primeiro (expected_date_descending) e vencendo por último (expected_date_descending) ou mesmo priorizar recebíveis de vendas mais antigas (transaction_date_ascending), o que na prática fará com que todos os recebíveis de uma venda sejam antecipados em conjunto, antes de partir para os recebíveis da próxima venda com excessão se o somatório dos recebíveis de uma venda ultrapasse o limite da margem do valor alvo. Caso não seja preenchido, será considerada a ordenação expected_date_descending

Enum:
Array [ 3 ]
partner_fee
number		($float)
example: 0.0094

Permite que o Marketplace cadastre ou altere sua taxa para ser aplicada sobre a antecipação requisitada pelo estabelecimento. Essa taxa não afeta a taxa comercial negociada.

Poderá deixar pré-cadastrada um a cobrança de fee para um determinado seller.

Valores maiores do que 1 irão resultar em Bad Request.
auto_commit
boolean		example: true|false

Permite desativar o transito automático do status simulated para ready. Se a requisição enviar em seu payload auto_commit=false, o status permanecerá simulated aguardando a confirmação do usuário da API através da requisição /commit. A operação /commit transita somente do status simulated para o status ready. O valor default é true.
fail_on_receivable_invalid
boolean		example: true|false
default: false

Com o valor default false a solicitação retornará sucesso e adicionará uma resposta a propriedade rejected_transactions, que conterá uma lista detalhada dos erros que invalidam as transações e/ou seus recebíveis. Com valor true, a requisição falhará e não será criada a solicitação, a mensagem de error conterá todos os detalhes da invalidação para cada transação e/ou seus recebíveis.

Pré-Cadastrando taxa de antecipação para o vendedor (seller)

É possível deixar uma taxa pré-cadastrada para um determinado vendedor (seller), e com isso não será necessário passar a informação na chave {partner_fee} da requisição de antecipação sob demanda.

ChaveValores
percent_amount
number		example: 0.01
default: 0

Valor percentual que será aplicado, sendo o valor mínimo é de 0(equivale a 0%) e o máximo de 0.9999(equivale a 99.99%). O percentual poderá variar entre menor que 1 ou maior ou igual a 0.
id_customer
string		example: {{customer_id}}

Seller para qual a taxa da antecipação será aplicada

Verificando Recebíveis Aptos a Antecipação

ChaveValores
prepayable_for
string		($date)
example: 2019-05-30

Retorna os recebíveis que estão aptos ao participar de uma antecipação a parir da data informada. Ao passar o valor da data, não será necessário a utilização das aspas. Ex.: prepayable_for=2019-05-30

Para retornar os recebíveis aptos a antecipação para um determinado seller, disponibilizamos um endpoint específico.

❗️

Liberação de antecipação

Para que seja possível fazer uso da API de antecipação, o parceiro deverá entrar em contato com o nosso time comercial responsável por sua conta.


Clique na imagem para aumentar.

Fluxo detalhado

  • Após a requisição da antecipação sob demanda a mesma passa a ficar com status "solicitada" (requested), onde fica passível de simulação por rotina automática.

  • Após a simulação, entrará no status "simulada" (simulated) ou "pronta" (ready) se o parâmetro auto_commit for passado com valor true, onde passam a ser preenchidos os campos de taxas aplicadas, valor total aplicado à antecipação de recebíveis selecionados.

  • Fica então passível de aprovação do nosso time Financeiro, que poderá torná-la "aprovada" (approved) ou "rejeitada" (rejected) dependendo da análise.

  • Uma vez aprovada, fica passível de realização da antecipação, onde após ficará com o status "realizada" (succeeded).

  • Não será possível cancelar uma solicitação de antecipação sob demanda via API. O status de "cancelado" (canceled). ocorre quando houver qualquer tipo de alteração nos recebíveis ou não ter sido aprovado.

  • Caso a solicitação de antecipação não seja aprovada até a data selecionada para sua realização, a solicitação irá para o status "expirada" (expired).

  • Ocasionando alguma situação no processo que impeça a antecipação de ser realizada, como por exemplo: Se algum de seus recebíveis tiverem sido cancelados por motivo de estorno/chargeback ou mesmo se outra antecipação tiver sido realizada com recebíveis utilizados nesta simulação, esta vai para o status "inválida" (invalid).

❗️

Importante

Essa simulação não está disponível no ambiente de teste.

O split invalida uma antecipação solicitada anteriormente.

Antecipação sob demanda (suporte)

Para os parceiros que não utilizam via API, disponibilizamos a solicitação da antecipação através do suporte.

Para solicitar essa liberação, clique aqui

Updated 7 days ago

Reclame Aqui - Certificado RA1000

Soluções

Por que a Zoop? Modelo de negócios

ZOOP BANKING

Serviços Bancários

ZOOP PAYMENTS

Online Presencial Unified Commerce

Soluções

Por que a Zoop? Modelo de negócios

ZOOP BANKING

Serviços Bancários

ZOOP PAYMENTS

Online Presencial Unified Commerce

SOBRE

Nossa história Trabalhe Conosco Banco de fornecedores Guideline

APARECEMOS NO SEU EXTRATO?

Entenda

TRANSPARÊNCIA

Compliance Política de Cookies Política de Privacidade Política de Segurança da Informação Cibernética Lei de Igualdade Salarial

Contato

Entenda

DOCUMENTAÇÃO E RECURSOS

Central de Ajuda Documentação Blog Conteúdos Ouvidoria Canal Ético

© Zoop - Todos os direitos reservados. Feito por desenvolvedores para desenvolvedores.

Voltar ao topo