A API permite a criação, consulta e simulação de ofertas, garantindo que os recebíveis sejam disponibilizados para antecipação de forma estruturada. Os métodos permitem a geração de novas ofertas, a consulta de ofertas existentes e a realização de simulações antes da formalização da negociação.

Create a New Offer

Permite a criação de uma nova oferta/agenda de antecipação, associando recebíveis a um valor disponibilizado para negociação.

📌 Endpoint

  • Método: POST
  • Endpoint: /offers

Após a criação, a oferta será registrada com um ID único, que poderá ser utilizado para acompanhamento e gestão da negociação.

Download Receivable Offer by ID

Permite o download dos recebíveis associados a uma oferta/agenda, retornando um arquivo referente a essa solicitação.

📌 Endpoint

  • Método: GET
  • Endpoint: /offers/{id}/download-receivable

O ID da oferta/agenda deve ser informado para que o arquivo correspondente seja recuperado e disponibilizado.

Calculate Offer Margins

Realiza o cálculo das margens de uma oferta com base na porcentagem e ID dos recebíveis, permitindo que o usuário avalie o impacto financeiro e opções disponíveis da antecipação antes da finalização da operação.

📌 Endpoint

  • Método: POST
  • Endpoint: /offers/percentage

Esse método fornece informações essenciais para tomada de decisão, garantindo que os valores negociados estejam dentro das margens esperadas.

Find Offers by Query Filters

Permite consultar as ofertas cadastradas na plataforma utilizando filtros específicos. Esse método possibilita recuperar ofertas com base em atributos como valor, status, datas e empresas envolvidas na operação.

📌 Endpoint

  • Método: GET
  • Endpoint: /offers

A consulta pode ser filtrada por diversos parâmetros, como:

  • bandeira do cartão
  • moeda da oferta
  • valor da oferta
  • valor total dos recebíveis
  • ID do adquirente
  • ID do investidor
  • status da oferta
  • data de criação
  • data de expiração

Esse método é útil para listar ofertas de forma segmentada, acompanhar o status das operações ou filtrar por critérios específicos de negócio.

Get Offer by ID

Permite recuperar os detalhes de uma oferta específica utilizando seu identificador único. Esse método retorna todas as informações associadas à oferta, incluindo valores, status, empresas envolvidas e dados dos recebíveis vinculados.

📌 Endpoint

  • Método: GET
  • Endpoint: /offers/{id}

Para utilizar este método, é necessário informar o ID da oferta que se deseja consultar. Essa funcionalidade é útil para visualizar informações completas de uma oferta específica antes de prosseguir com etapas como proposta ou formalização.

Cancel Offer

Permite cancelar uma oferta existente de forma simples, informando apenas o identificador da oferta. Uma vez cancelada, a oferta deixa de estar disponível para receber propostas.

📌 Endpoint

  • Método: PUT
  • Endpoint: /offers/{id}/cancel

Para realizar o cancelamento, é necessário informar o ID da oferta que se deseja cancelar. Este método é útil quando a oferta ainda não foi formalizada ou negociada e o cancelamento é necessário por motivos operacionais ou estratégicos.

Status

StatusDescrição
DisponívelAgenda disponível para receber oferta ou aguardando o adquirente aceitar ou recusar proposta.
ExpiradoA agenda passou do período para receber oferta.
AprovadoProposta aceita pelo adquirente, investidor deve realizar o upload do contrato.
PendenteContrato inserido na plataforma, aguardando aceite do adquirente.
NegociadoAgenda aceita pelo adquirente e o contrato já foi colocado dentro da plataforma.
Liquidado ParcialParte dos recebíveis da agenda foi paga.
LiquidadoTodos os recebíveis da agenda já foram pagos.