Pular para o conteúdo principal

Listar produtos elegíveis

GET 
/v1/products/eligibles

Retorna todos os produtos elegíveis.

Request​

Query Parameters

    expand string

    Expande as referências.

    Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

    Example: data.loan
    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

    document string

    Um filtro com base no campo document. O valor deve ser uma string ou uma lista separada por vírgula

    Examples:

    Valor único

    Example: 1245678900

    starting_after string

    Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

    Example: obj_5f92f01728e009f403d8502e
    ending_before string

    Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

    Example: obj_5f92f01728e009f403d8502e
    limit integer

    Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

    Default value: 10
    Example: 10
    status any

    O status do produto. O valor deve ser uma string.

    Example: active
    grossSalary number

    Um parâmetro para substituir o campo grossSalary do employment. O valor deve ser um número

    Examples:

    Valor único

    Example: 2400

    netSalary number

    Um parâmetro para substituir o campo netSalary do employment. O valor deve ser um número

    Examples:

    Valor único

    Example: 2000

    limitPerInstallment number

    Um parâmetro para substituir o campo limitPerInstallment do employment. O valor deve ser um número

    Examples:

    Valor único

    Example: 1600

    limitPerLoan number

    Um parâmetro para substituir o campo limitPerLoan do employment. O valor deve ser um número

    Examples:

    Valor único

    Example: 22000

    hiredAt string

    Um parâmetro para substituir o campo hiredAt do employment. O valor deve ser uma string

    Examples:

    Valor único

    Example: 2020-01-01T00:00:00.000Z

    loansToIgnore string

    Pode ser um valor único ou uma lista separada por vírgula para excluir empréstimos da verificação de produtos elegíveis.

Responses​

Um objeto com data e um array de ProductEligible após starting_after. Se vazio, não há mais itens. Solicitação sempre bem-sucedida.

Schema

    hasMore boolean

    Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

    Example: true

    data

    object[]

    Uma lista de produtos

  • Array [

    • product string

    Identificador único do produto

    Example: prod_6352a35384c95868100e226c
    slug string
    Example: consignado
    name string

    Nome do produto elegível.

    description string

    Descrição detalhada do produto elegível.

    maxLoanAmount double

    Montante máximo do empréstimo que pode ser concedido para este produto.

    minLoanAmount double

    Montante mínimo do empréstimo que pode ser concedido para este produto.

    maxNumberOfInstallments integer

    Número máximo de parcelas permitidas para o empréstimo neste produto.

    minNumberOfInstallments integer

    Número mínimo de parcelas permitidas para o empréstimo neste produto.

    maxInstallmentValue double

    Valor máximo de cada parcela para o empréstimo neste produto.

    minInstallmentValue double

    Valor mínimo de cada parcela para o empréstimo neste produto.

    customer string

    Identificador único do cliente.

    employment string

    Identificador único do vinculo empregatício.

    available boolean

    Indica se o produto está disponível para empréstimo.

    metadata object

    Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

  • ]

Loading...