GET
/
v1
/
offers
/
{offer}
Obter oferta
curl --request GET \
  --url https://api.base39.io/v1/offers/{offer} \
  --header 'Authorization: Bearer <token>'
{
  "id": "offr_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": "tac",
      "amountType": "absolute",
      "amount": 200,
      "description": "<string>"
    }
  ],
  "fine": {
    "fineRate": 0.02,
    "interestBase": "workdays",
    "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.

Path Parameters

​
offer
string
required

ID da oferta

Query Parameters

​
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.

​
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.

Response

200 - application/json

Retorna o objeto Offer para um ID válido.

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.

​
interestType
string

Tipo de juros aplicado na dívida.

​
creditOperationType
string

Tipo de operação de crédito

​
expectedDisbursementDate
string<date>

Data de desembolso no padrão ISO 8601

​
interestGracePeriod
integer
​
principalGracePeriod
integer
​
numberOfInstallments
integer
​
firstDueDate
string<date>

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[]
​
fine
object

Definição de multa.

​
cashout
(CashoutTransfer · object | CashoutBoleto · object | CashoutInvoice · object)[]
​
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<date-time>

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"