SettingsProducts

Configurações de produtos

eligibility

object

type string

Define como a elegibildiade será calculada.

O tipo mock deve ser usado apenas para testes. Use dynamic para integrar com uma API externa. Para produtos que não exigem verificações, use o tipo static.

Possible values: [static, dynamic, mock]

Example: static

options

object

anyOf

dynamic

url string

headers object

metadata object

mock

maxLoanAmount number

Valor máximo da solicitação de empréstimo.

Example: 10000

minLoanAmount number

Valor mínimo da solicitação de empréstimo.

Example: 200

maxNumberOfInstallments integer

Quantidade máximo de parcelas.

Example: 48

minNumberOfInstallments integer

Quantidade mínima de parcelas.

Example: 6

maxInstallmentValue integer

Valor máximo de cada parcela.

Example: 5000

minInstallmentValue integer

Valor mínimo de cada parcela.

Example: 0

offer

type string

Use o tipo online quando o processamento do produto e oferta serão feitos pela plataforma. Use offline para redirecionamento externo.

Possible values: [online, offline, mock]

Example: online

options

object

anyOf

mock

monthlyFee number

Taxa de juros mensal

Example: 1.99

numberOfInstallments integer[]

Opções de parcelas

Example: [12,24]

daysUntilDisbursement integer

Dias até o desembolso. Essa informação é usada para calcular a oferta.

Example: 7

monthsUntilFirstDueDate integer

Quantidade de meses de carência até o vencimento da primeira parcela.

Example: 1

creditOperationType string

Tipo da operação de crédito.

Example: CCB

rebates

object[]

Array [

anyOf

RebatePercentage

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

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

]

insurance

object

amount number

Example: 0

fee number

Example: 1.73

type string

Possible values: [required, optional, uninsured]

Example: required

number string

Example: 123456

insurer string

Example: Cia de Seguros

offline

url string

headers object

metadata object

numberOfInstallments integer[]

online

url string

headers object

metadata object

numberOfInstallments integer[]

documents

object

toCreate

object[]

deprecated

Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc… ATENÇÃO: Este campo entrará em desuso em breve, utilize os steps para definir quais documentos deverão ser criados.

Array [

purpose string

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

method string

Template engine usado para gerar documentos.

Possible values: [google]

methodData

object

template string

Template utilizado no engine para gerar o documento.

]

toRequest

object[]

documentos solicitados durante o fluxo de contratação, exemplos: RG, CPF, Holerite, Comprovante de endereço…

Array [

purpose string

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

name string

Nome do documento.

Example: crédito consignado

owner string

Identificador do responsável por solicitar/criar o documento.

Possible values: [customer, operator]

Example: customer

expireInDays integer

Número de dias até a expiração.

Possible values: >= 1

Example: 30

]

disbursement string
Nome do método de desembolso configurado na API de Configurações
Example: custom