Obter empréstimo

GET /v1/loans/:loan

Retorna um objeto Loan

Request

Path Parameters

loan stringrequired

ID do empréstimo

Example: loan_5f92f01728e009f403d8502e

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.

Example: data.loan

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.

Examples:

inclusao
exclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

Retorna todos os campos, exceto `id`.

Example: -id

Responses

Retorna o objeto Loan para um ID válido. Se o empréstimo estiver excluído, incluirá a propriedade deleted como true.

application/json

Schema
Example (from schema)

Schema

idstring

Identificador exclusivo para o objeto.

Example: loan_5f92f01728e009f403d8502e

statusstring[]

Status do empréstimo

Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

Default value: draft

Example: draft

externalIdstring

Example: 4eeb7525-40c6-45fe-8236-2b731d740fad

employmentstring

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.

customerstring

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

companystring

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

contractNumberstring

Número do contrato

Example: AB123456789

cashout

object[]

Array [

anyOf

CashoutTransfer
CashoutBoleto
CashoutInvoice
CashoutLoan

Especificação para desembolso em conta bancária

amountdoublerequired

paymentMethodstringrequired

typestringrequired

Default value: payment_method

Especificação para desembolso em boleto

amountdoublerequired

typeableLinestringrequired

Linha digitável do boleto.

dueDatedaterequired

Data de vencimento do boleto.

beneficiary

object

required

namestringrequired

documentstringrequired

Documento de identificação da empresa. Deve ser o CNPJ.

Possible values: Value must match regular expression ^[0-9]+

typestringrequired

Default value: boleto

Especificação para desembolso em fatura interna

amountdoublerequired

invoicestringrequired

typestringrequired

Default value: invoice

Especificação para desembolso em conta bancária

amountdouble

loanstringrequired

typestringrequired

Default value: loan

dueDatedate

invoicestring

]

offer

object

anyOf

Offer
MOD2

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

CashoutTransfer
CashoutBoleto
CashoutInvoice
CashoutLoan

Especificação para desembolso em conta bancária

amountdoublerequired

paymentMethodstringrequired

typestringrequired

Default value: payment_method

Especificação para desembolso em boleto

amountdoublerequired

typeableLinestringrequired

Linha digitável do boleto.

dueDatedaterequired

Data de vencimento do boleto.

beneficiary

object

required

namestringrequired

documentstringrequired

Documento de identificação da empresa. Deve ser o CNPJ.

Possible values: Value must match regular expression ^[0-9]+

typestringrequired

Default value: boleto

Especificação para desembolso em fatura interna

amountdoublerequired

invoicestringrequired

typestringrequired

Default value: invoice

Especificação para desembolso em conta bancária

amountdouble

loanstringrequired

typestringrequired

Default value: loan

dueDatedate

invoicestring

]

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

transactionsobject[]

attachments

object[]

Array [

filestring

Example: file_6307b6c39f5d3d917009b631

linkedAtdate-time

]

context

object

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

ipstring

headersobject

fingerprintstring

geolocationstring[]

history

undefined[]

Array [

descriptionstring

statusstring[]

Status do empréstimo

Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

Default value: draft

Example: draft

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

]

signatures

object[]

Array [

signerstring

Signatário do empréstimo. Pode ser um customer ou operator.

context

idstring

Identificador exclusivo para o objeto.

Example: sign_5f92f01728e009f403d8502e

signedAtdate

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.

context

object

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

ipstring

headersobject

fingerprintstring

geolocationstring[]

]

insurance

object

proposalIdstring

Identificador da proposta do seguro.

saleIdstring

Identificador da venda do seguro.

cancellationIdstring

Identificador do cancelamento do seguro.

amountRemainingdouble

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

Example: 1500

amountForPaymentdouble

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

Example: 1487.9

isRefinancingstring

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.

Example: false

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

{
  "id": "loan_5f92f01728e009f403d8502e",
  "status": "draft",
  "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
  "employment": "string",
  "customer": "string",
  "company": "string",
  "contractNumber": "AB123456789",
  "cashout": [
    {},
    {},
    {},
    {}
  ],
  "offer": {},
  "transactions": [
    {
      "amount": 0,
      "description": "string",
      "createdAt": "2024-07-29"
    }
  ],
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631",
      "linkedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "context": {
    "ip": "string",
    "headers": {},
    "fingerprint": "string",
    "geolocation": [
      "string"
    ]
  },
  "history": [
    {
      "description": "string",
      "status": "draft",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z"
    }
  ],
  "signatures": [
    {
      "signer": "string",
      "context": {
        "id": "sign_5f92f01728e009f403d8502e",
        "signedAt": "2024-07-29",
        "metadata": {},
        "context": {
          "ip": "string",
          "headers": {},
          "fingerprint": "string",
          "geolocation": [
            "string"
          ]
        }
      }
    }
  ],
  "insurance": {
    "proposalId": "string",
    "saleId": "string",
    "cancellationId": "string"
  },
  "amountRemaining": 1500,
  "amountForPayment": 1487.9,
  "isRefinancing": false,
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Obter empréstimo

/v1/loans/:loan

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses