LoanCreate - Base39

Criar um empréstimo

employment

string

required

Id do vinculo empregatício ou um objeto com os dados do vinculo empregatício nas operações de leitura quando usado o modo expand.

customer

string

required

Id do cliente ou um objeto com os dados do cliente nas operações de leitura quando usado o modo expand.

company

string

required

Id da empresa ou um objeto com os dados da empresa nas operações de leitura quando usado o modo expand.

offer

object

required

Este objeto representa uma oferta de um empréstimo.

offer.id

string

Identificador exclusivo para o objeto.

Example:

"offr_5f92f01728e009f403d8502e"

offer.disbursementAmount

number

Valor solicitado

offer.installmentAmount

number

Valor da parcela.

offer.totalAmount

number

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

offer.interestAmount

number

Valor total dos Juros.

offer.iofAmount

number

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

offer.iofAdditionalAmount

number

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

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

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

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

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

offer.insurance

object

Definição do seguro vinculado a oferta de empréstimo.

offer.interestType

string

Tipo de juros aplicado na dívida.

offer.creditOperationType

string

Tipo de operação de crédito

offer.expectedDisbursementDate

string

Data de desembolso no padrão ISO 8601

offer.interestGracePeriod

integer

offer.principalGracePeriod

integer

offer.numberOfInstallments

integer

offer.firstDueDate

string

Data do primeiro vencimento

offer.fund

string

Identificador que faz referência a um fundo.

Example:

"fund_637b85aaa8e91c82fd053aac"

offer.product

string

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

Example:

"prod_637cf14e316408250c0bd067"

offer.description

string

offer.rebates

object[]

offer.fine

object

Definição de multa.

offer.cashout

object[]

Especificação para desembolso em conta bancária

offer.creditPolicy

string

Política de crédito utilizada para a oferta

Example:

"crpl_637b85aaa8e91c82fd053aac"

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

offer.createdAt

string

Data de criação do objeto

Example:

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

status

string

default:open

Status do empréstimo

Example:

"open"

externalId

string

Example:

"4eeb7525-40c6-45fe-8236-2b731d740fad"

contractNumber

string

Número do contrato

Example:

"AB123456789"

cashout

object[]

Especificação para desembolso em conta bancária

attachments

object[]

context

object

Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation

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.

OfferCreate CustomerCreate

{
  "status": "open",
  "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
  "employment": "<string>",
  "customer": "<string>",
  "company": "<string>",
  "contractNumber": "AB123456789",
  "cashout": [
    {
      "amount": 123,
      "paymentMethod": "<string>",
      "type": "payment_method"
    }
  ],
  "offer": {
    "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": "<string>"
      }
    ],
    "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
    "metadata": {},
    "createdAt": "2023-08-25T22:38:41.134Z"
  },
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631",
      "linkedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "context": {
    "ip": "<string>",
    "headers": {},
    "fingerprint": "<string>",
    "geolocation": [
      "<string>"
    ]
  },
  "metadata": {}
}

Referências