Pular para o conteúdo principal

Listar Corbans por Promotora de Crédito

Este serviço permite listar Corbans associados a uma promotora de crédito específico, com paginação e opções de ordenação para facilitar a navegação e organização dos resultados.

Endpoint para Listar Corbans por Promotora de Crédito​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/corbans/credit-promoter

Parâmetros de Consulta​

Parâmetros de Paginação​

  • page (number, obrigatório): O número da página a ser exibida.
  • pageSize (number, obrigatório): O número de resultados por página.

Parâmetros de Filtro​

  • creditPromoterId (number, obrigatório): ID da promotora de crédito para o qual os Corbans serão listados.

Parâmetros de Ordenação (opcionais)​

  • sortBy (string): Campo pelo qual os resultados serão ordenados (exemplo: legalName).
  • sortDirection (string): Direção da ordenação (asc para ascendente ou desc para descendente).

Exemplo de Requisição com curl para Listar Corbans por Promotora de Crédito​

curl -X GET "https://bff-dev.granatech.com.br/api/corbans/credit-promoter?page=1&pageSize=10&creditPromoterId=1&sortBy=legalName&sortDirection=asc"

Estrutura da Resposta​

A resposta para esta requisição contém os seguintes campos:

  • data (array de Corban): Lista dos Corbans associados ao promotor de crédito especificado.
  • totalPages (number): Número total de páginas de resultados.

Exemplo de Resposta​

{
  "data": [
    {
      "id": 1,
      "document": "12345678000100",
      "legalName": "Corban Legal 1",
      "businessName": "Corban Comercial 1",
      "automaticApproval": true,
      "financialSettingsId": "f1234567890",
      "creditPromoterId": 1,
      "createdAt": "2024-01-15T10:00:00.000Z"
    },
    {
      "id": 2,
      "document": "98765432000199",
      "legalName": "Corban Legal 2",
      "businessName": "Corban Comercial 2",
      "automaticApproval": false,
      "financialSettingsId": "f0987654321",
      "creditPromoterId": 1,
      "createdAt": "2024-02-10T15:30:00.000Z"
    }
  ],
  "totalPages": 5
}

Observações​

  1. Identificação do Promotora de Crédito: Certifique-se de que o parâmetro creditPromoterId está preenchido para que a listagem de Corbans associados seja retornada corretamente.
  2. Ordenação: Utilize os parâmetros sortBy e sortDirection para organizar a listagem conforme desejado. A ordenação é útil para visualizar os Corbans em uma sequência específica, como por nome legal ou data de criação.
  3. Paginação: Controle a quantidade de resultados exibidos em cada página e navegue pelas páginas usando os parâmetros page e pageSize.

Este endpoint é útil para obter uma lista completa e organizada dos Corbans sob responsabilidade de um promotor de crédito específico.