Crédito Vendor Finance documentação.

Documentação de integração end-to-end do fluxo de liberação de limite de crédito, gestão de crédito e antecipação.

Todas apis são autenticadas, utilizando Authorization Bearer

O token deve ser solicitado para o time de negócios.

Configuração

Urls

Apis

Vendor Finance Api

Fluxo default de integração Vendor Finance

Passo 1 - Cadastro do Cliente / Solicitação de Limite de Crédito

Api endpoint

Create Account (solicitação de limit para o cliente) {{endpoint}}/api/payment/creditscore/v2/account

Get account by document {{endpoint}}/api/payment/creditscore/limit/{idOrDocument}

Através desta API deve ser enviado o cadastro dos clientes que devem ser executados no Motor de Crédito Vendor Finance.

O Motor tem um tempo de execução de 2 minutos em média. Uma vez executado o motor as informações ficam disponíveis para consulta.

Considerações:

Deve ser enviado o CNPJ do seller quem vende/fatura o pedido sellerDocument.
No campo platformType deve ser enviado a origem do pedido, sendo: ON para pedidos feitos no e-commerce e OFF feitos em canais de vendas físicas, via representante ou diretamente pelo ERP.

Passo 2 - Configuração de call back de limite de crédito

Api endpoint:

Configurate callback endpoint PUT {{endpoint}}/api/payment/creditscore/limit/configuration/callback

Configurate callback endpoint GET {{endpoint}}/api/payment/creditscore/limit/configuration/callback

Todo registro de novos clientes enviados para o motor de Crédito deve ser configurada a URL de Callback para que, quando o motor termine de executar a política de crédito para o cliente, a Vendor Finance possa devolver o limite de Crédito e Status gerados de forma automática, sem a necessidade do seller ter que consultar dentro da solução.

Passo 3 - Reserva do Limite de Crédito

Após ter o limite de crédito IFC disponibilizado pelo motor de Crédito, o cliente poderá seguir com a sua compra através do canal de venda do Seller. No momento da confirmação do pedido, a plataforma de venda deve realizar a autorização de reserva de limite de crédito para a Vendor Finance através da API abaixo:

Api endpoint:

Authorization (reserva do limite) {{endpoint}}/api/payment/creditscore/limit/authorization

Get Authorization by external id (reserva do limite) {{endpoint}}/api/payment/creditscore/limit/authorization/{accountDocument}/{externalId}

Get Authorization by transactionId (reserva do limite) {{endpoint}}/api/payment/creditscore/limit/authorization/{id}

O pedido só poderá ser concluído após a aprovação da reserva. Caso a reserva não seja aprovada, o pedido não poderá ser concluído.

Passo 4 - Confirmação de Utilização do Limite de Crédito

Após o faturamento do pedido e geração do boleto faturado, devem ser enviadas essas mesmas informações para a solução de Crédito Vendor Finance, através da API abaixo:

Api endpoint:

Transaction (confirmação utilização do limite reservado) {{endpoint}}/api/payment/creditscore/limit/transaction

Considerações:

Deve ser enviado o CNPJ do seller que faturou a NF no campo 'subsidiaryDocument'.
O range de 'Nosso número' é disponibilizado pelo time Vendor Finance, onde cada faixa deve ser atribuída a um boleto. O dígito deve ser calculado.

Passo 5 - Envio do XML da NF

O XML da NF deve ser enviado para a Vendor Finance após o envio da confirmação de utilização do limite.
Apenas operações que tenham o XML da NF integrado, será aprovado pelo FIDC para que seja feita a antecipação de pagamento.

Api endpoint:

Invoice - Cria nota usando XML {{endpoint}}/api/payment/creditscore/fidic/upload/{accountDocument}/{externalId}/xml

Fluxo de exceção de integração Trade Finance

Cancelamento da Reserva do Limite

Caso o pedido seja cancelado pelo cliente ou distribuidor, deve ser enviada a solicitação de cancelamento do pedido para a Vendor Finance, para realizar o cancelamento da reserva de limite de crédito.

Api endpoint:

Cancel Authorization (cancelamento reserva do limit) {{endpoint}}/api/payment/creditscore/limit/authorization/cancel

Sugestão de Limite - OPCIONAL

Caso o cliente não tenha um limite de crédito satisfatório ou o mesmo que queira fazer uma compra com um valor maior que o limite disponível, é possível que o seller solicite uma reanálise de limite informando qual o limite ideal para aquele determinado cliente através da API abaixo:

Api endpoint:

Suggestion Credit Limit *{{endpoint}}/api/payment/creditscore/limit/suggestion

O prazo para execução do motor segue o mesmo para a análise de um novo cadastro, 2 minutos, porém caso o cadastro caia na mesa de Crédito existe um SLA de até 72 horas para análise.

É possível solicitar a reanálise de crédito via Portal Crédito Vendor Finance.

Segunda Via de Boleto - OPCIONAL

Caso desejado é possível gerar a segunda via do Boleto através da API abaixo:

Api endpoint:

Customer Bill Copy *{{endpoint}}/api/payment/creditscore/limit/print-bill/{accountDocument}/{externalId}/{installment}

É possível gerar a segunda via do boleto via Portal Crédito Vendor Finance.

Prorrogação de Vencimento - OPCIONAL

Caso tenha atraso na entrega logística ou o cliente não consiga pagar dentro do vencimento. É possível solicitar a prorrogação do vencimento do boleto gerado.

Api endpoint:

Create Solicitation Installment Extension *{{endpoint}}/api/payment/creditscore/solicitations/customer/extensions

Installment Extension Status {{endpoint}}/api/payment/creditscore/solicitations/customer/extensions/status/{{idSolicitation}}

É possível solicitar a prorrogação de vencimento do boleto via Portal Crédito Vendor Finance.

Devolução Total ou Parcial - OPCIONAL

Caso seja necessário realizar uma devolução total ou parcial do pedido gerado e integrado, a Vendor Finance deve ser informada para que possa realizar a recompra dos títulos já adiantados.

O envio da solicitação pode ser feita pela API abaixo:

Api endpoint:

Create Solicitation Return Limit {{endpoint}}/api/payment/creditscore/solicitations/customer/limit-return

Get transaction return by document and externalId {{endpoint}}/api/payment/creditscore/solicitations/customer/limit-return/{{document}}/{{externalId}}

É possível solicitar a prorrogação de vencimento do boleto via Portal Crédito Vendor Finance.

Flow Off platform


Flow On platform


Data Dictionaries