<aside> <img src="/icons/map-pin_blue.svg" alt="/icons/map-pin_blue.svg" width="40px" />

Índice de páginas

Core AI Docs

Versões

1.2

1.1

1.0

</aside>

Resumo

Abaixo estão descritos os endpoints que compõem o fluxo de requisição de uma antecipação. Esse fluxo é responsável por permitir que emissores antecipem valores a receber com base em contratos com status pre_approved.

O processo contempla desde a verificação de contratos pré-aprovados até a solicitação da antecipação e a conciliação dos pagamentos. Ele exige validações contratuais, aceite de termos legais e envio de informações cadastrais obrigatórias.


Fluxo

image.png

Com base nos dados enviados ao [POST] /upload_external_data, possibilitamos que um recebível seja antecipado, seguindo o fluxo abaixo.

  1. Pré-aprovados: O processo de solicitação de antecipação se inicia no endpoint [GET] /get_pre_approved, onde é possível verificar os recebíveis elegíveis.
  2. Aceite de termos: Para cumprir as políticas da LGPD e do Banco Central do Brasil, o solicitante da antecipação deve aceitar os termos através do endpoint [POST] /accept_terms.
  3. Habilitação da antecipação: O recebível a ser antecipado deve ser enviado através do endpoint [POST] /enable_anticipation.
  4. Consulta de ofertas: Após o envio do recebível, a Core AI disponibiliza as opções de antecipação para esse contrato no endpoint [POST] /get_offers.
  5. Solicitação de antecipação: A antecipação propriamente dita é solicitada através do endpoint [POST] /request_anticipation.

É importante notar que, a qualquer momento, informações detalhadas sobre um recebível, como status e dados de desembolso, podem ser consultadas no endpoint [GET] /get_receivable_data.

<aside> ⚠️

Vale notar que um recebível que se encontra com status entre requested e signed não podem receber uma nova solicitação, até que seu status fique como canceled, rejected ou disbursed.

</aside>


Visão Geral dos Endpoints

[GET] /get_pre_approved

Este endpoint retorna, de forma paginada, todos os contratos recebidos, pré-aprovados e pré-rejeitados pela Core AI. Aqui, é possível filtrar por external_contract_id e external_issuer_id. É importante observar que, após o envio de dados via [POST] /upload_external_data, o processo de pré-aprovação pode levar até 24 horas para ser concluído. Emissores que possuírem um contrato que esteja no processo de antecipação terão, para este mesmo contrato, o status de pre-rejected.

[POST] /accept_terms

Este endpoint é responsável por receber os dados do aceite dos termos para habilitar o fluxo de antecipação. Aqui devem ser enviadas informações do cliente, que são necessárias legalmente, para obter dados do banco central. Um emissor deve aprovar o termo uma única vez. Caso uma nova versão do termo seja feita, cabe ao cliente solicitar a aprovação do novo ao emissor, e informar a Core AI, via este endpoint.

[POST] /enable_anticipation

Este endpoint recebe as informações de um contrato, para que seja possível a realização de sua antecipação. Para um contrato ser enabled é necessário que o emissor tenha aceitado os termos e tenha o status de pre_approved.

[POST] /get_offers

Este endpoint obtém as ofertas disponíveis de antecipação para um contrato e emissor específico. Para obter as ofertas é necessário ter um contrato enabled e um emissor que aceitou os termos.

[POST] /request_anticipation

Este endpoint é responsável por receber o id da oferta de antecipação escolhida, por parte do emissor. Junto a esses dados são esperadas informações referentes a conta onde o emissor gostaria de ter seu dinheiro depositado (tipo de chave pix, e seu respectivo valor). Vale notar que até esse passo, a antecipação não foi confirmada por parte da Core AI, foi feita apenas uma solicitação. Vale notar que realizamos o depósito apenas na conta do emissor.

[GET] /get_receivable_data

Este endpoint retorna dados de um contrato que já foi habilitado, quer tenha sido antecipado ou não. Por meio dele, é possível ver o status do contrato, dados da solicitação e do desembolso.