GET
/
v1
/
loans
/
{loan}

Authorizations

Authorization
string
headerrequired

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

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

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Response

200 - application/json
id
string

Identificador exclusivo para o objeto.

status
string
default: draft

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

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.

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.

createdBy
object
updatedBy
object
Listar empréstimos