POST
/
v1
/
products
/
{product}
/
offers

Authorizations

Authorization
string
headerrequired

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

Headers

base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

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

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json
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
id
string

Identificador exclusivo para o objeto.

customer
string

Identificador do cliente.

employment
string
required

Identificador do funcionário.

company
string
required

Identificador da empresa.

disbursementAmount
number
required

Valor solicitado

installmentAmount
number

Valor da parcela.

totalAmount
number
required

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
required
firstDueDate
string
required

Data do primeiro vencimento

fund
string
required

Identificador que faz referência a um fundo.

product
string
required

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

Obter ofertaObter parcela