Atualizar política de crédito

POST /v1/credit-policies/:id

Atualiza uma política de crédito.

Request

Path Parameters

id stringrequired

O ID do object

Example: obj_5f92f01728e009f403d8502e

Header Parameters

Idempotency-Key string

Chave única de idempotência para evitar duplicação de requisições.

Example: 5f92f01728e009f403d8502e

base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

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

RebatePercentage
RebateAbsolute

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

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount doublerequired

Valor da tarifa.

Example: 200

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

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

CreditPolicyInsuranceRequiredAndUninsured
CreditPolicyInsuranceOptional

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

Objeto insurance quando seguro é opcional

fee double

Taxa percentual do valor do seguro

type string

Tipo do seguro.

optional: seguro contributário

Possible values: [optional]

Default value: optional

number string

Número da apólice de seguro

insurer string

Nome da seguradora

optionalFee double

Taxa adicional opcional quando tipo de seguro é optional (não contributário)

Default value: 0.05

]

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.

Responses

Retorna o objeto CreditPolicy se a atualização for bem-sucedida; retorna erro se os parâmetros forem inválidos.

application/json

Schema
Example (from schema)

Schema

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

RebatePercentage
RebateAbsolute

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

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

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount doublerequired

Valor da tarifa.

Example: 200

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

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

CreditPolicyInsuranceRequiredAndUninsured
CreditPolicyInsuranceOptional

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

Objeto insurance quando seguro é opcional

fee double

Taxa percentual do valor do seguro

type string

Tipo do seguro.

optional: seguro contributário

Possible values: [optional]

Default value: optional

number string

Número da apólice de seguro

insurer string

Nome da seguradora

optionalFee double

Taxa adicional opcional quando tipo de seguro é optional (não contributário)

Default value: 0.05

]

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

{
  "id": "crpl_5f92f01728e009f403d8502e",
  "status": "active",
  "name": "Consignado",
  "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
  "product": "prod_5f92f01728e009f403d8502e",
  "options": {
    "interestType": "pre_price_days",
    "creditOperationType": "ccb",
    "rebates": [
      {},
      {}
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "calendar_days",
      "monthlyRate": 0.02
    },
    "rules": [
      {
        "workingMonthsRangeStart": 6,
        "workingMonthsRangeEnd": 12,
        "salaryMultiples": 2,
        "minimumDisbursementAmount": 200,
        "maximumDisbursementAmount": 2000,
        "fund": "fund_5f92f01728e009f403d8502e",
        "monthlyFee": [
          {
            "installmentsRangeStart": 12,
            "installmentsRangeEnd": 36,
            "amount": 0.02,
            "insurance": {}
          }
        ]
      }
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Atualizar política de crédito

/v1/credit-policies/:id

Request​

Path Parameters

Header Parameters

Body

Responses​

Request

Responses