POST
/
v1
/
credit-policies
curl --request POST \
  --url https://api.base39.io/v1/credit-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "active",
  "name": "Consignado",
  "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
  "product": "prod_5f92f01728e009f403d8502e",
  "options": {
    "interestType": "pre_price_days",
    "creditOperationType": "ccb",
    "rebates": [
      {
        "feeType": "registration",
        "amountType": "absolute",
        "amount": 200,
        "description": "Tarifa de cadastro"
      }
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "calendar_days",
      "monthlyRate": 0.02
    },
    "rules": [
      {
        "workingMonthsRangeStart": 6,
        "workingMonthsRangeEnd": 12,
        "salaryMultiples": 2,
        "minimumDisbursementAmount": 200,
        "fund": "fund_5f92f01728e009f403d8502e",
        "monthlyFee": [
          {
            "installmentsRangeStart": 12,
            "installmentsRangeEnd": 36,
            "amount": 0.02,
            "insurance": {
              "fee": 123,
              "type": "uninsured",
              "number": "<string>",
              "insurer": "<string>"
            }
          }
        ]
      }
    ]
  },
  "metadata": {}
}'
{
  "id": "crpl_5f92f01728e009f403d8502e",
  "status": "active",
  "name": "Consignado",
  "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
  "product": "prod_5f92f01728e009f403d8502e",
  "options": {
    "interestType": "pre_price_days",
    "creditOperationType": "ccb",
    "rebates": [
      {
        "feeType": "registration",
        "amountType": "absolute",
        "amount": 200,
        "description": "Tarifa de cadastro"
      }
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "calendar_days",
      "monthlyRate": 0.02
    },
    "rules": [
      {
        "workingMonthsRangeStart": 6,
        "workingMonthsRangeEnd": 12,
        "salaryMultiples": 2,
        "minimumDisbursementAmount": 200,
        "fund": "fund_5f92f01728e009f403d8502e",
        "monthlyFee": [
          {
            "installmentsRangeStart": 12,
            "installmentsRangeEnd": 36,
            "amount": 0.02,
            "insurance": {
              "fee": 123,
              "type": "uninsured",
              "number": "<string>",
              "insurer": "<string>"
            }
          }
        ]
      }
    ]
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

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

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.

Body

application/json

Criar uma política de crédito

​
status
enum<string>
required
Available options:
active,
inactive
​
name
string
required

Nome da política de crédito.

Example:

"Consignado"

​
product
string
required

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.

​
model
enum<string>
Available options:
EMPLOYMENT_LENGTH_SALARY_MULTIPLIER
Example:

"EMPLOYMENT_LENGTH_SALARY_MULTIPLIER"

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

Response

201 - application/json
Retorna o objeto `CreditPolicy` se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos.

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

​
id
string

Identificador exclusivo para o objeto.

Example:

"crpl_5f92f01728e009f403d8502e"

​
status
enum<string>
Available options:
active,
inactive
​
name
string

Nome da política de crédito.

Example:

"Consignado"

​
model
enum<string>
Available options:
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.

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

Data de criação do objeto

Example:

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

​
updatedAt
string

Data de alteração do objeto

Example:

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

​
deleted
boolean
default:false

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

Example:

false