POST
/
v1
/
credit-policies

Authorizations

Authorization
string
headerrequired

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.

product
string
required

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

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

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

id
string

Identificador exclusivo para o objeto.

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

Nome da política de crédito.

model
enum<string>
Available options:
EMPLOYMENT_LENGTH_SALARY_MULTIPLIER
product
string

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

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

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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