Calcular oferta

POST

products

{product}

offers

curl --request POST \
  --url https://api.base39.io/v1/products/{product}/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "disbursementAmount": 123,
  "customer": "<string>",
  "employment": "<string>",
  "customerDocument": "<string>",
  "companyDocument": "<string>",
  "loansToIgnore": [
    "<string>"
  ],
  "metadata": {}
}'

{
  "id": "offr_5f92f01728e009f403d8502e",
  "customer": "cust_5f92f01728e009f403d8502e",
  "employment": "empl_5f92f01728e009f403d8502e",
  "company": "comp_5f92f01728e009f403d8502e",
  "disbursementAmount": 123,
  "installmentAmount": 123,
  "totalAmount": 123,
  "interestAmount": 123,
  "iofAmount": 123,
  "iofAdditionalAmount": 123,
  "monthlyCET": 0.02,
  "yearlyCET": 0.12,
  "monthlyFee": 0.02,
  "yearlyFee": 0.12,
  "insurance": {
    "amount": 123,
    "fee": 0.02,
    "type": "required",
    "number": "<string>",
    "insurer": "<string>"
  },
  "interestType": "<string>",
  "creditOperationType": "<string>",
  "expectedDisbursementDate": "2023-12-25",
  "interestGracePeriod": 123,
  "principalGracePeriod": 123,
  "numberOfInstallments": 123,
  "firstDueDate": "2023-12-25",
  "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": [
    {
      "amount": 123,
      "paymentMethod": "<string>",
      "type": "payment_method"
    }
  ],
  "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z"
}

Authorizations

Authorization

string

header

required

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

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

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

Este objeto representa uma oferta de um empréstimo.

employment

string

required

Identificador do funcionário.

Example:

"empl_5f92f01728e009f403d8502e"

company

string

required

Identificador da empresa.

Example:

"comp_5f92f01728e009f403d8502e"

disbursementAmount

number

required

Valor solicitado

totalAmount

number

required

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

numberOfInstallments

integer

required

firstDueDate

string

required

Data do primeiro vencimento

fund

string

required

Identificador que faz referência a um fundo.

Example:

"fund_637b85aaa8e91c82fd053aac"

product

string

required

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

Example:

"prod_637cf14e316408250c0bd067"

string

Identificador exclusivo para o objeto.

Example:

"offr_5f92f01728e009f403d8502e"

customer

string

Identificador do cliente.

Example:

"cust_5f92f01728e009f403d8502e"

installmentAmount

number

Valor da parcela.

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.

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

description

string

rebates

object[]

fine

object

Definição de multa.

cashout

object[]

Especificação para desembolso em conta bancária

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"

curl --request POST \
  --url https://api.base39.io/v1/products/{product}/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "disbursementAmount": 123,
  "customer": "<string>",
  "employment": "<string>",
  "customerDocument": "<string>",
  "companyDocument": "<string>",
  "loansToIgnore": [
    "<string>"
  ],
  "metadata": {}
}'

{
  "id": "offr_5f92f01728e009f403d8502e",
  "customer": "cust_5f92f01728e009f403d8502e",
  "employment": "empl_5f92f01728e009f403d8502e",
  "company": "comp_5f92f01728e009f403d8502e",
  "disbursementAmount": 123,
  "installmentAmount": 123,
  "totalAmount": 123,
  "interestAmount": 123,
  "iofAmount": 123,
  "iofAdditionalAmount": 123,
  "monthlyCET": 0.02,
  "yearlyCET": 0.12,
  "monthlyFee": 0.02,
  "yearlyFee": 0.12,
  "insurance": {
    "amount": 123,
    "fee": 0.02,
    "type": "required",
    "number": "<string>",
    "insurer": "<string>"
  },
  "interestType": "<string>",
  "creditOperationType": "<string>",
  "expectedDisbursementDate": "2023-12-25",
  "interestGracePeriod": 123,
  "principalGracePeriod": 123,
  "numberOfInstallments": 123,
  "firstDueDate": "2023-12-25",
  "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": [
    {
      "amount": 123,
      "paymentMethod": "<string>",
      "type": "payment_method"
    }
  ],
  "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z"
}

Visão geral

Ingestão de dados

Consulta de dados

Calcular oferta

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response