Pular para o conteúdo principal

Offer

Este objeto representa uma oferta de um empréstimo.

idstring

Identificador exclusivo para o objeto.

Example: offr_5f92f01728e009f403d8502e
customerstring

Identificador do cliente.

Example: cust_5f92f01728e009f403d8502e
employmentstringrequired

Identificador do funcionário.

Example: empl_5f92f01728e009f403d8502e
companystringrequired

Identificador da empresa.

Example: comp_5f92f01728e009f403d8502e
disbursementAmountdoublerequired

Valor solicitado

installmentAmountdouble

Valor da parcela.

totalAmountdoublerequired

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

interestAmountdouble

Valor total dos Juros.

iofAmountdouble

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

iofAdditionalAmountdouble

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

monthlyCETdouble

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
yearlyCETdouble

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
monthlyFeedouble

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

Example: 0.02
yearlyFeedouble

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.

amountdouble
feedouble

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

Example: 0.02
typestring

Possible values: [required, optional, uninsured]

numberstring
insurerstring
interestTypestring

Tipo de juros aplicado na dívida.

creditOperationTypestring

Tipo de operação de crédito

expectedDisbursementDatedate

Data de desembolso no padrão ISO 8601

interestGracePeriodinteger
principalGracePeriodinteger
numberOfInstallmentsintegerrequired
firstDueDatedaterequired

Data do primeiro vencimento

fundstringrequired

Identificador que faz referência a um fundo.

Example: fund_637b85aaa8e91c82fd053aac
productstringrequired

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

Example: prod_637cf14e316408250c0bd067
descriptionstring
rebates object[]
  • Array [
    • feeTypestring

    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
    amountTypestring

    Tipo do valor a ser cobrado.

    Possible values: [absolute]

    Example: absolute
    amountdouble

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

    Example: 0.2
    descriptionstring

    Descrição para a tarifa.

    Example: Tarifa de cadastro
  • ]
    • fine object

    Definição de multa.

    fineRatedouble

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

    Example: 0.02
    interestBasestring

    Contagem do tempo para multa (calendar para dias corridos)

    Possible values: [calendar_days]

    monthlyRatedouble

    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
    amountdoublerequired
    paymentMethodstringrequired
    typestringrequired
    Default value: payment_method
  • ]
    • creditPolicystring

    Política de crédito utilizada para a oferta

    Example: crpl_637b85aaa8e91c82fd053aac
    metadataobject

    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.

    createdAtdate-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    Offer
    {
      "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": [
        {
          "amount": 0,
          "paymentMethod": "string",
          "type": "payment_method"
        },
        {
          "amount": 0,
          "typeableLine": "string",
          "dueDate": "2024-07-29",
          "beneficiary": {
            "name": "string",
            "document": "string"
          },
          "type": "boleto"
        },
        {
          "amount": 0,
          "invoice": "string",
          "type": "invoice"
        },
        {
          "amount": 0,
          "loan": "string",
          "type": "loan",
          "dueDate": "2024-07-29",
          "invoice": "string"
        }
      ],
      "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z"
    }