Pular para o conteúdo principal

CreditPolicies

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

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: crpl_5f92f01728e009f403d8502e
    status string

    Possible values: [active, inactive]

    name string

    Nome da política de crédito.

    Example: Consignado
    model string

    Possible values: [EMPLOYMENT_LENGTH_SALARY_MULTIPLIER]

    Example: EMPLOYMENT_LENGTH_SALARY_MULTIPLIER
    product string

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

    Example: prod_5f92f01728e009f403d8502e

    options

    object

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

    interestType stringrequired

    Tipo de juros aplicado na dívida.

    Possible values: [pre_price_days]

    Example: pre_price_days
    creditOperationType stringrequired

    Tipo de operação de crédito

    Possible values: [ccb]

    Example: ccb

    rebates

    object[]

    required

  • Array [

    • anyOf

    Detalhes das taxas de um empréstimo.

    feeType stringrequired

    Tipo da tarifa.

    all_loans: utilizado para indicar tarifas ou taxas de manutenção em cada contratação. first_loan: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC). except_first_loan: utilizado para representar taxas de manutenção em cada contratação, exceto a primeira.

    Possible values: [all_loans, first_loan, except_first_loan]

    Example: first_loan
    amountType stringrequired

    Tipo do valor a ser cobrado.

    Possible values: [percentage]

    Example: percentage
    amount doublerequired

    Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.

    Example: 0.2
    description stringrequired

    Descrição para a tarifa.

    Example: Tarifa de cadastro
    minAmount number

    Valor mínimo para aplicação da tarifa.

    Example: 200
    maxAmount number

    Valor máximo para aplicação da tarifa.

    Example: 2000

  • ]

    • fine

    object

    required

    fineRate doublerequired

    Valor percentual da multa

    Example: 0.02
    interestBase stringrequired

    Contagem do tempo para multa (calendar para dias corridos)

    Possible values: [calendar_days]

    Example: calendar_days
    monthlyRate doublerequired

    Valor percentual mensal da multa

    Example: 0.02

    rules

    object[]

    required

  • Array [

    • workingMonthsRangeStart integerrequired

    Quantidade mínima em meses de trabalho

    Example: 6
    workingMonthsRangeEnd integerrequired

    Quantidade máxima em meses de trabalho

    Example: 12
    salaryMultiples numberrequired

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

    Example: 2
    minimumDisbursementAmount integerrequired

    Valor mínimo da solicitação

    Example: 200
    maximumDisbursementAmount integer

    Valor máximo da solicitação

    Example: 2000
    fund stringrequired

    ID do Fundo

    Example: fund_5f92f01728e009f403d8502e

    monthlyFee

    object[]

    required

  • Array [

    • installmentsRangeStart integerrequired

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

    Example: 12
    installmentsRangeEnd integerrequired

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

    Example: 36
    amount doublerequired

    Taxa de juros mensal

    Example: 0.02

    insurance

    object

    oneOf

    Objeto insurance quando seguro é uninsured ou required

    fee double

    Taxa percentual do valor do seguro

    type string

    Tipo do seguro.

    required: seguro não contributário uninsured: empréstimo sem seguro

    Possible values: [required, uninsured]

    Default value: uninsured
    number string

    Número da apólice de seguro

    insurer string

    Nome da seguradora

  • ]

  • ]

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

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deleted boolean

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]