Listar políticas de crédito

Retorna todas as políticas de crédito.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

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

Query Parameters

exclude_fields

string

Campos a remover do corpo da resposta. O valor deve ser uma string ou uma lista separada por vírgula. Campos informados que não existem na resposta serão descartados.

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.

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.

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 `CreditPolicy` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de políticas de crédito.

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 políticas de crédito

Este objeto representa uma política de crédito.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"crpl_5f92f01728e009f403d8502e"

data.status

enum<string>

Available options:

active,

inactive

data.name

string

Nome da política de crédito.

Example:

"Consignado"

data.model

enum<string>

Available options:

EMPLOYMENT_LENGTH_SALARY_MULTIPLIER

Example:

"EMPLOYMENT_LENGTH_SALARY_MULTIPLIER"

data.product

string

Id do produto associado a política de crédito.

Example:

"prod_5f92f01728e009f403d8502e"

data.options

object

Modelo que aplica uma taxa de juros em faixas baseado no tempo de casa em meses.

Show child attributes

data.options.interestType

enum<string>

required

Tipo de juros aplicado na dívida.

Available options:

pre_price_days

Example:

"pre_price_days"

data.options.creditOperationType

enum<string>

required

Tipo de operação de crédito

Available options:

ccb

Example:

"ccb"

data.options.rebates

object[]

required

Show child attributes

data.options.rebates.feeType

enum<string>

required

Tipo da tarifa.

registration: utilizado para indicar tarifas ou taxas de manutenção. tac: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC).

Available options:

registration,

spread,

tac

Example:

"registration"

data.options.rebates.amountType

enum<string>

required

Tipo do valor a ser cobrado

Available options:

absolute,

percentage

Example:

"absolute"

data.options.rebates.amount

number

required

Valor da tarifa

Example:

200

data.options.rebates.description

string

Descrição para a tarifa.

Example:

"Tarifa de cadastro"

data.options.fine

object

required

Show child attributes

data.options.fine.fineRate

number

required

Valor percentual da multa

Example:

0.02

data.options.fine.interestBase

enum<string>

required

Contagem do tempo para multa (calendar para dias corridos e workdays para dias úteis)

Available options:

workdays,

calendar_days,

calendar_days_365

Example:

"calendar_days"

data.options.fine.monthlyRate

number

required

Valor percentual mensal da multa

Example:

0.02

data.options.rules

object[]

required

Show child attributes

data.options.rules.workingMonthsRangeStart

integer

required

Quantidade mínima em meses de trabalho

Example:

6

data.options.rules.workingMonthsRangeEnd

integer

required

Quantidade máxima em meses de trabalho

Example:

12

data.options.rules.salaryMultiples

number

required

Múltiplo de salário para o valor máximo

Example:

2

data.options.rules.minimumDisbursementAmount

integer

required

Valor mínimo da solicitação

Example:

200

data.options.rules.fund

string

required

ID do Fundo

Example:

"fund_5f92f01728e009f403d8502e"

data.options.rules.monthlyFee

object[]

required

Show child attributes

data.options.rules.monthlyFee.installmentsRangeStart

integer

required

Quantidade mínima da faixa de número de parcelas

Example:

12

data.options.rules.monthlyFee.installmentsRangeEnd

integer

required

Quantidade máxima da faixa de número de parcelas

Example:

36

data.options.rules.monthlyFee.amount

number

required

Taxa de juros mensal

Example:

0.02

data.options.rules.monthlyFee.insurance

object

Show child attributes

data.options.rules.maximumDisbursementAmount

integer

Valor máximo da solicitação

Example:

2000

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

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false