Criar política de crédito

POST /v1/credit-policies

Cria uma política de crédito.

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

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

statusstringrequired

Possible values: [active, inactive]

namestringrequired

Nome da política de crédito.

Example: Consignado

modelstring

Possible values: [EMPLOYMENT_LENGTH_SALARY_MULTIPLIER]

Example: EMPLOYMENT_LENGTH_SALARY_MULTIPLIER

productstringrequired

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

Example: prod_5f92f01728e009f403d8502e

options

object

required

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

interestTypestringrequired

Tipo de juros aplicado na dívida.

Possible values: [pre_price_days]

Example: pre_price_days

creditOperationTypestringrequired

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.

feeTypestringrequired

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

amountTypestringrequired

Tipo do valor a ser cobrado.

Possible values: [percentage]

Example: percentage

amountdoublerequired

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

Example: 0.2

descriptionstringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

minAmountnumber

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

Example: 200

maxAmountnumber

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

Example: 2000

Detalhes das taxas de um empréstimo.

feeTypestringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountTypestringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amountdoublerequired

Valor da tarifa.

Example: 200

descriptionstringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

fine

object

required

fineRatedoublerequired

Valor percentual da multa

Example: 0.02

interestBasestringrequired

Contagem do tempo para multa (calendar para dias corridos)

Possible values: [calendar_days]

Example: calendar_days

monthlyRatedoublerequired

Valor percentual mensal da multa

Example: 0.02

rules

object[]

required

Array [

workingMonthsRangeStartintegerrequired

Quantidade mínima em meses de trabalho

Example: 6

workingMonthsRangeEndintegerrequired

Quantidade máxima em meses de trabalho

Example: 12

salaryMultiplesnumberrequired

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

Example: 2

minimumDisbursementAmountintegerrequired

Valor mínimo da solicitação

Example: 200

maximumDisbursementAmountinteger

Valor máximo da solicitação

Example: 2000

fundstringrequired

ID do Fundo

Example: fund_5f92f01728e009f403d8502e

monthlyFee

object[]

required

Array [

installmentsRangeStartintegerrequired

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

Example: 12

installmentsRangeEndintegerrequired

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

Example: 36

amountdoublerequired

Taxa de juros mensal

Example: 0.02

insurance

object

oneOf

CreditPolicyInsuranceRequiredAndUninsured
CreditPolicyInsuranceOptional

Objeto insurance quando seguro é uninsured ou required

feedouble

Taxa percentual do valor do seguro

typestring

Tipo do seguro.

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

Possible values: [required, uninsured]

Default value: uninsured

numberstring

Número da apólice de seguro

insurerstring

Nome da seguradora

Objeto insurance quando seguro é opcional

feedouble

Taxa percentual do valor do seguro

typestring

Tipo do seguro.

optional: seguro contributário

Possible values: [optional]

Default value: optional

numberstring

Número da apólice de seguro

insurerstring

Nome da seguradora

optionalFeedouble

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

Default value: 0.05

]

metadataobject

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 criação for bem-sucedida; retorna erro se os parâmetros forem inválidos.

application/json

Schema
Example (from schema)

Schema

idstring

Identificador exclusivo para o objeto.

Example: crpl_5f92f01728e009f403d8502e

statusstring

Possible values: [active, inactive]

namestring

Nome da política de crédito.

Example: Consignado

modelstring

Possible values: [EMPLOYMENT_LENGTH_SALARY_MULTIPLIER]

Example: EMPLOYMENT_LENGTH_SALARY_MULTIPLIER

productstring

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.

interestTypestringrequired

Tipo de juros aplicado na dívida.

Possible values: [pre_price_days]

Example: pre_price_days

creditOperationTypestringrequired

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.

feeTypestringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: first_loan

amountTypestringrequired

Tipo do valor a ser cobrado.

Possible values: [percentage]

Example: percentage

amountdoublerequired

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

Example: 0.2

descriptionstringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

minAmountnumber

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

Example: 200

maxAmountnumber

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

Example: 2000

Detalhes das taxas de um empréstimo.

feeTypestringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountTypestringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amountdoublerequired

Valor da tarifa.

Example: 200

descriptionstringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

fine

object

required

fineRatedoublerequired

Valor percentual da multa

Example: 0.02

interestBasestringrequired

Contagem do tempo para multa (calendar para dias corridos)

Possible values: [calendar_days]

Example: calendar_days

monthlyRatedoublerequired

Valor percentual mensal da multa

Example: 0.02

rules

object[]

required

Array [

workingMonthsRangeStartintegerrequired

Quantidade mínima em meses de trabalho

Example: 6

workingMonthsRangeEndintegerrequired

Quantidade máxima em meses de trabalho

Example: 12

salaryMultiplesnumberrequired

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

Example: 2

minimumDisbursementAmountintegerrequired

Valor mínimo da solicitação

Example: 200

maximumDisbursementAmountinteger

Valor máximo da solicitação

Example: 2000

fundstringrequired

ID do Fundo

Example: fund_5f92f01728e009f403d8502e

monthlyFee

object[]

required

Array [

installmentsRangeStartintegerrequired

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

Example: 12

installmentsRangeEndintegerrequired

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

Example: 36

amountdoublerequired

Taxa de juros mensal

Example: 0.02

insurance

object

oneOf

CreditPolicyInsuranceRequiredAndUninsured
CreditPolicyInsuranceOptional

Objeto insurance quando seguro é uninsured ou required

feedouble

Taxa percentual do valor do seguro

typestring

Tipo do seguro.

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

Possible values: [required, uninsured]

Default value: uninsured

numberstring

Número da apólice de seguro

insurerstring

Nome da seguradora

Objeto insurance quando seguro é opcional

feedouble

Taxa percentual do valor do seguro

typestring

Tipo do seguro.

optional: seguro contributário

Possible values: [optional]

Default value: optional

numberstring

Número da apólice de seguro

insurerstring

Nome da seguradora

optionalFeedouble

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

Default value: 0.05

]

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

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"
  }
}

Criar política de crédito

/v1/credit-policies

Request​

Query Parameters

Header Parameters

Body

Responses​

Request

Responses