Criar empréstimo

Cria um novo empréstimo.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única de idempotência para evitar duplicação de requisições.

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

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.

Body

application/json

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

required

Identificador da oferta.

externalId

string

contractNumber

string

Número do contrato

cashout

object[]

• CashoutTransfer
• CashoutBoleto
• CashoutInvoice
• CashoutBoleto

Show child attributes

attachments

object[]

Show child attributes

context

object

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

Show child attributes

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

201 - application/json

Este objeto representa um empréstimo.

id

string

Identificador exclusivo para o objeto.

status

string

default: open

Status do empréstimo

externalId

string

employment

string

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

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

company

string

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

contractNumber

string

Número do contrato

cashout

object[]

• CashoutTransfer
• CashoutBoleto
• CashoutInvoice
• CashoutBoleto

Show child attributes

offer

object

Este objeto representa uma oferta de um empréstimo.

Show child attributes

transactions

object[]

Show child attributes

attachments

object[]

Show child attributes

context

object

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

Show child attributes

history

object[]

Show child attributes

signatures

object[]

Show child attributes

amountRemaining

number

Valor restante para pagamento, será apresentado caso seja informado o parâmetro payment_for.

amountForPayment

number

Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

isRefinancing

string

Este campo informa se o empréstimo é um refinanciamento. Ele é preenchido automaticamente, levando em conta os dados do campo cashout, e não pode ser preenchido de forma manual.

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

updatedAt

string

Data de alteração do objeto

deleted

boolean

default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.