Offer

Este objeto representa uma oferta de um empréstimo.

id

string

Identificador exclusivo para o objeto.

Example:

"offr_5f92f01728e009f403d8502e"

disbursementAmount

number

Valor solicitado

installmentAmount

number

Valor da parcela.

totalAmount

number

Valor total da dívida. Inclui tarifas, impostos, valor desembolsado, IOF, taxas e juros.

interestAmount

number

Valor total dos Juros.

iofAmount

number

Valor total do IOF (Imposto sobre Operações Financeiras).

iofAdditionalAmount

number

Valor da taxa única da [alíquota adicional do IOF (Imposto sobre Operações Financeiras) (decreto 6.339/08).

monthlyCET

number

Custo efetivo total ao mês. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

Example:

0.02

yearlyCET

number

Custo efetivo total ao ano. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.a.

Example:

0.12

monthlyFee

number

Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

Example:

0.02

yearlyFee

number

Taxa anual. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.m.

Example:

0.12

insurance

object

Definição do seguro vinculado a oferta de empréstimo.

Show child attributes

insurance.amount

number

insurance.fee

number

Taxa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

Example:

0.02

insurance.type

enum<string>

Available options:

required,

optional,

uninsured

insurance.number

string

insurance.insurer

string

interestType

string

Tipo de juros aplicado na dívida.

creditOperationType

string

Tipo de operação de crédito

expectedDisbursementDate

string

Data de desembolso no padrão ISO 8601

interestGracePeriod

integer

principalGracePeriod

integer

numberOfInstallments

integer

firstDueDate

string

Data do primeiro vencimento

fund

string

Identificador que faz referência a um fundo.

Example:

"fund_637b85aaa8e91c82fd053aac"

product

string

Identificador do produto no qual este empréstimo foi criado.

Example:

"prod_637cf14e316408250c0bd067"

description

string

rebates

object[]

Show child attributes

rebates.feeType

enum<string>

required

Tipo da tarifa.

registration: utilizado para indicar tarifas ou taxas de manutenção. tac: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC).

Available options:

tac,

spread,

registration

rebates.amountType

enum<string>

required

Tipo do valor a ser cobrado

Available options:

absolute,

percentage

rebates.amount

number

required

Valor da tarifa.

Example:

200

rebates.description

string

Descrição para a tarifa.

fine

object

Definição de multa.

Show child attributes

fine.fineRate

number

Valor percentual fixo da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

Example:

0.02

fine.interestBase

enum<string>

Contagem do tempo para multa (calendar para dias corridos e workdays para dias úteis)

Available options:

workdays,

calendarDays

fine.monthlyRate

number

Valor percentual mensal da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

Example:

0.02

cashout

object[]

• CashoutTransfer
• CashoutBoleto
• CashoutInvoice
• CashoutBoleto

Especificação para desembolso em conta bancária

Show child attributes

cashout.amount

number

required

cashout.paymentMethod

string

required

cashout.type

string

default:payment_method

required

creditPolicy

string

Política de crédito utilizada para a oferta

Example:

"crpl_637b85aaa8e91c82fd053aac"

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"