POST
/
v1
/
loans
/
{loan}
/
void

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.

Path Parameters

loan
string
required

ID do empréstimo

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

Este objeto representa um 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[]
offer
object

Este objeto representa uma oferta de um empréstimo.

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.

Response

200 - 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[]
offer
object

Este objeto representa uma oferta de um empréstimo.

transactions
object[]
attachments
object[]
context
object

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

history
object[]
signatures
object[]
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.

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.

Cancelar empréstimoMarcar empréstimo como expirado