Listar as Linhas de Crédito cadastradas

Esse endpoint permite a busca de linhas de créditos já cadastradas para o produto na visão do Originador. É possível realizar paginação e vários filtros no resultado.

Parâmetros da URL

  • page (integer): O número da página para paginação.
  • size (integer): O número de itens por página.
  • consolided_condition (boolean): Flag para indicar se serão consideradas somente condições consolidadas.
  • status (string): Status da linha de crédito.
  • application_id (string/uuid v4): ID da aplicação.
  • borrower_id (string/uuid v4): ID do tomador.
  • employer_id (string/uuid v4): ID do empregador.
  • role (string): Tipo do cliente. Possíveis valores aceitos: EMPLOYER, BORROWER.
  • borrower_employer_id (string/uuid v4): ID do relacionamento de empregador e tomador.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • content (object): Objeto contendo o resultado com as linhas de crédito que atendam aos filtros aplicados.
  • total_pages (int): Quantidade de páginas para paginação.
  • total_elements (int): Quantidade total de registros encontrados.
  • has_next (boolean): Flag para indicar se terá a próxima página para paginação.
Objeto "content"
  • id (string/uuid v4): Identificador da linha de crédito criada.
  • funding (object): Objeto contendo os dados do Financiador.
  • role (string): Tipo do tomador.
  • employer (object): Objeto contendo os dados do empregador, se aplicável.
  • borrower (object): Objeto contendo os dados do tomador, se aplicável.
  • status (string): Status da analise da solicitação realizada. Possíveis valores: QUALIFIED,
  • product (object): Objeto contendo os dados do produto utilizado para cálculo da linha de crédito.
  • created_at (datetime): Data e hora do cadastro da solicitação da linha de crédito.
  • version (int): Número da versão da solicitação.
Objeto "funding"
  • id (string/uuid v4): ID de identificação do Financiador desta operação (Cessonário, Credor).
  • legal_name (string): Razão social do Financiador.
  • alias (string): Nome fantasia do Financiador.
  • metadata (object): Objeto contendo metadados associados ao cadastro do Financiador.
Objeto "borrower"
  • id (string/uuid v4): ID de identificação da pessoa tomadora do empréstimo.
  • name (string): Nome do tomador.
Objeto "product"
  • id (string/uuid v4): Identiificação do produto.
  • name (string): Nome do produto.
  • description (string): Descrição do produto.

Exemplo de JSON:

{
  "content": [
    {
      "id": "",
      "funding": {
        "id": "",
        "legal_name": "",
        "alias": "",
        "metadata": {}
      },
      "employer": {
        "id": "",
        "legal_name": ""
      },
      "role": "BORROWER",
      "status": "",
      "borrower": {
        "id": "",
        "name": ""
      },
      "borrower_employer": {
        "id": ""
      },
      "product": {
        "id": "",
        "name": "",
        "description": ""
      },
      "created_at": "",
      "updated_at": "",
      "version": ""
    }
  ],
  "total_pages": "",
  "total_elements": "",
  "has_next": ""
}

Language
URL
Click Try It! to start a request and see the response here!