GET
/
v1
/
products
/
eligibles
curl --request GET \
  --url https://api.base39.io/v1/products/eligibles \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "product": "prod_6352a35384c95868100e226c",
      "slug": "consignado",
      "name": "<string>",
      "description": "<string>",
      "maxLoanAmount": 123,
      "minLoanAmount": 123,
      "maxNumberOfInstallments": 123,
      "minNumberOfInstallments": 123,
      "maxInstallmentValue": 123,
      "minInstallmentValue": 123,
      "customer": "<string>",
      "employment": "<string>",
      "available": true,
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

​
document
string

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

​
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.

​
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.

​
limit
integer
default:10

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

​
status
enum<string>

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

Available options:
active,
inactive
Example:

"active"

​
loansToIgnore
string

Pode ser um valor único ou uma lista separada por vírgula. Utilizado para indicar quais empréstimos não devem ser considerados ao verificar os produtos elegíveis.

Response

200 - application/json
Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `ProductEligible` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de produtos elegíveis.

​
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

Este objeto representa um produto elegível.