Calcular oferta

POST 
/v1/products/:product/offers

Calcula uma oferta.

Request

Path Parameters

product stringrequired
ID do produto
Example: prod_5f92f01728e009f403d8502e

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.
Example: data.loan
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.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

base39-external-client-id string

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

application/json

Body

disbursementAmount doublerequired

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.

Responses

200

Retorna o objeto Offer se o cálculo for bem-sucedido. Retorna um erro para parâmetros inválidos.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: offr_5f92f01728e009f403d8502e
customer string
Identificador do cliente.
Example: cust_5f92f01728e009f403d8502e
employment stringrequired
Identificador do funcionário.
Example: empl_5f92f01728e009f403d8502e
company stringrequired
Identificador da empresa.
Example: comp_5f92f01728e009f403d8502e
disbursementAmount doublerequired

Valor solicitado

installmentAmount double

Valor da parcela.

totalAmount doublerequired

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

interestAmount double

Valor total dos Juros.

iofAmount double

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

iofAdditionalAmount double

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

monthlyCET double
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 double
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 double
Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.
Example: 0.02
yearlyFee double
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.

amount double

fee double

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

Example: 0.02

type string

Possible values: [required, optional, uninsured]

number string

insurer string
interestType string

Tipo de juros aplicado na dívida.

creditOperationType string

Tipo de operação de crédito

expectedDisbursementDate date

Data de desembolso no padrão ISO 8601

interestGracePeriod integer
principalGracePeriod integer
numberOfInstallments integerrequired
firstDueDate daterequired

Data do primeiro vencimento

fund stringrequired
Identificador que faz referência a um fundo.
Example: fund_637b85aaa8e91c82fd053aac
product stringrequired
Identificador do produto no qual este empréstimo foi criado.
Example: prod_637cf14e316408250c0bd067
description string

rebates

object[]

Array [

feeType string

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. insurance_premium: utilizado para representar tarifas de seguro.

Possible values: [all_loans, first_loan, except_first_loan, insurance_premium]

Example: first_loan

amountType string

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount double

Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.

Example: 0.2

description string

Descrição para a tarifa.

Example: Tarifa de cadastro

]

fine

object

Definição de multa.

fineRate double

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

Example: 0.02

interestBase string

Contagem do tempo para multa (calendar para dias corridos)

Possible values: [calendar_days]

monthlyRate double

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

Array [

anyOf

CashoutTransfer

Especificação para desembolso em conta bancária

amount doublerequired

paymentMethod stringrequired

type stringrequired

Default value: payment_method

CashoutBoleto

Especificação para desembolso em boleto

amount doublerequired

typeableLine stringrequired

Linha digitável do boleto.

dueDate daterequired

Data de vencimento do boleto.

beneficiary

object

required

name stringrequired

document stringrequired

Documento de identificação da empresa. Deve ser o CNPJ.

Possible values: Value must match regular expression ^[0-9]+

type stringrequired

Default value: boleto

CashoutInvoice

Especificação para desembolso em fatura interna

amount doublerequired

invoice stringrequired

type stringrequired

Default value: invoice

CashoutLoan

Especificação para desembolso em conta bancária

amount double

loan stringrequired

type stringrequired

Default value: loan

dueDate date

invoice string

]

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 date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z

Example (from schema)

{
  "id": "offr_5f92f01728e009f403d8502e",
  "customer": "cust_5f92f01728e009f403d8502e",
  "employment": "empl_5f92f01728e009f403d8502e",
  "company": "comp_5f92f01728e009f403d8502e",
  "disbursementAmount": 0,
  "installmentAmount": 0,
  "totalAmount": 0,
  "interestAmount": 0,
  "iofAmount": 0,
  "iofAdditionalAmount": 0,
  "monthlyCET": 0.02,
  "yearlyCET": 0.12,
  "monthlyFee": 0.02,
  "yearlyFee": 0.12,
  "insurance": {
    "amount": 0,
    "fee": 0.02,
    "type": "required",
    "number": "string",
    "insurer": "string"
  },
  "interestType": "string",
  "creditOperationType": "string",
  "expectedDisbursementDate": "2024-07-29",
  "interestGracePeriod": 0,
  "principalGracePeriod": 0,
  "numberOfInstallments": 0,
  "firstDueDate": "2024-07-29",
  "fund": "fund_637b85aaa8e91c82fd053aac",
  "product": "prod_637cf14e316408250c0bd067",
  "description": "string",
  "rebates": [
    {
      "feeType": "first_loan",
      "amountType": "absolute",
      "amount": 0.2,
      "description": "Tarifa de cadastro"
    }
  ],
  "fine": {
    "fineRate": 0.02,
    "interestBase": "calendar_days",
    "monthlyRate": 0.02
  },
  "cashout": [
    {},
    {},
    {},
    {}
  ],
  "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z"
}

Loading...