POST
/
v1
/
products
/
{product}
/
offers

Authorizations

Authorization
string
headerrequired

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

Path Parameters

product
string
required

ID do produto

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.

fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar uma oferta

disbursementAmount
number
required

Valor solicitado

customer
string
employment
string
customerDocument
string

Documento do tipo CPF utilizado para realizar a simulação da oferta no caso em que o customer não é fornecido.

companyDocument
string

Documento do tipo CNPJ utilizado para realizar a simulação da oferta no caso em que o employment não é fornecido.

loansToIgnore
string[]
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

200 - application/json

Este objeto representa uma oferta de um empréstimo.

id
string

Identificador exclusivo para o objeto.

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.

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.

monthlyFee
number

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

yearlyFee
number

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

insurance
object

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

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.

product
string

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

description
string
rebates
object[]
fine
object

Definição de multa.

cashout
object[]
creditPolicy
string

Política de crédito utilizada para a oferta

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