Criar empréstimo

POST /v1/loans

Cria um novo empréstimo.

Request

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

Header Parameters

Idempotency-Key string

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

Example: 5f92f01728e009f403d8502e

base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

externalId string

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

employment stringrequired

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 stringrequired

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

company stringrequired

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

Example: AB123456789

cashout

object[]

Array [

anyOf

CashoutTransfer
CashoutBoleto
CashoutInvoice
CashoutLoan

Especificação para desembolso em conta bancária

amount doublerequired

paymentMethod stringrequired

type stringrequired

Default value: payment_method

Especificação para desembolso em boleto

amount doublerequired

typeableLine stringrequired

Linha digitável do boleto.

dueDate daterequired

Data de vencimento do boleto.

beneficiary

object

required

name stringrequired

document stringrequired

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

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

type stringrequired

Default value: boleto

Especificação para desembolso em fatura interna

amount doublerequired

invoice stringrequired

type stringrequired

Default value: invoice

Especificação para desembolso em conta bancária

amount double

loan stringrequired

type stringrequired

Default value: loan

dueDate date

invoice string

]

offer

object

required

anyOf

MOD1

Identificador da oferta.

string

attachments

object[]

Array [

file string

Example: file_6307b6c39f5d3d917009b631

]

context

object

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

ip string

headers object

fingerprint string

geolocation string[]

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.

Responses

Retorna o objeto Loan se a atualização for bem-sucedida. Retorna um erro se os parâmetros forem inválidos.

application/json

Schema
Example (from schema)

Schema

id string

Identificador exclusivo para o objeto.

Example: loan_5f92f01728e009f403d8502e

status string[]

Status do empréstimo

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

Default value: draft

Example: draft

externalId string

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

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

Example: AB123456789

cashout

object[]

Array [

anyOf

CashoutTransfer
CashoutBoleto
CashoutInvoice
CashoutLoan

Especificação para desembolso em conta bancária

amount doublerequired

paymentMethod stringrequired

type stringrequired

Default value: payment_method

Especificação para desembolso em boleto

amount doublerequired

typeableLine stringrequired

Linha digitável do boleto.

dueDate daterequired

Data de vencimento do boleto.

beneficiary

object

required

name stringrequired

document stringrequired

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

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

type stringrequired

Default value: boleto

Especificação para desembolso em fatura interna

amount doublerequired

invoice stringrequired

type stringrequired

Default value: invoice

Especificação para desembolso em conta bancária

amount double

loan stringrequired

type stringrequired

Default value: loan

dueDate date

invoice string

]

offer

object

anyOf

Offer
MOD2

Este objeto representa uma oferta de um empréstimo.

id string

Identificador exclusivo para o objeto.

Example: offr_5f92f01728e009f403d8502e

customer string

Identificador do cliente.

Example: cust_5f92f01728e009f403d8502e

employment stringrequired

Identificador do funcionário.

Example: empl_5f92f01728e009f403d8502e

company stringrequired

Identificador da empresa.

Example: comp_5f92f01728e009f403d8502e

disbursementAmount doublerequired

Valor solicitado

installmentAmount double

Valor da parcela.

totalAmount doublerequired

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

interestAmount double

Valor total dos Juros.

iofAmount double

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

iofAdditionalAmount double

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

monthlyCET double

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

yearlyCET double

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

monthlyFee double

Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

Example: 0.02

yearlyFee double

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.

amount double

fee double

Taxa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

Example: 0.02

type string

Possible values: [required, optional, uninsured]

number string

insurer string

interestType string

Tipo de juros aplicado na dívida.

creditOperationType string

Tipo de operação de crédito

expectedDisbursementDate date

Data de desembolso no padrão ISO 8601

interestGracePeriod integer

principalGracePeriod integer

numberOfInstallments integerrequired

firstDueDate daterequired

Data do primeiro vencimento

fund stringrequired

Identificador que faz referência a um fundo.

Example: fund_637b85aaa8e91c82fd053aac

product stringrequired

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

Example: prod_637cf14e316408250c0bd067

description string

rebates

object[]

Array [

feeType string

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

amountType string

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount double

Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.

Example: 0.2

description string

Descrição para a tarifa.

Example: Tarifa de cadastro

]

fine

object

Definição de multa.

fineRate double

Valor percentual fixo da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

Example: 0.02

interestBase string

Contagem do tempo para multa (calendar para dias corridos)

Possible values: [calendar_days]

monthlyRate double

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

amount doublerequired

paymentMethod stringrequired

type stringrequired

Default value: payment_method

Especificação para desembolso em boleto

amount doublerequired

typeableLine stringrequired

Linha digitável do boleto.

dueDate daterequired

Data de vencimento do boleto.

beneficiary

object

required

name stringrequired

document stringrequired

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

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

type stringrequired

Default value: boleto

Especificação para desembolso em fatura interna

amount doublerequired

invoice stringrequired

type stringrequired

Default value: invoice

Especificação para desembolso em conta bancária

amount double

loan stringrequired

type stringrequired

Default value: loan

dueDate date

invoice string

]

creditPolicy string

Política de crédito utilizada para a oferta

Example: crpl_637b85aaa8e91c82fd053aac

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 date-time

Data de criação do objeto

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

transactions object[]

attachments

object[]

Array [

file string

Example: file_6307b6c39f5d3d917009b631

linkedAt date-time

]

context

object

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

ip string

headers object

fingerprint string

geolocation string[]

history

undefined[]

Array [

description string

status string[]

Status do empréstimo

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

Default value: draft

Example: draft

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 date-time

Data de criação do objeto

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

]

signatures

object[]

Array [

signer string

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

context

id string

Identificador exclusivo para o objeto.

Example: sign_5f92f01728e009f403d8502e

signedAt date

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.

context

object

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

ip string

headers object

fingerprint string

geolocation string[]

]

insurance

object

proposalId string

Identificador da proposta do seguro.

saleId string

Identificador da venda do seguro.

cancellationId string

Identificador do cancelamento do seguro.

amountRemaining double

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

Example: 1500

amountForPayment double

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

Example: 1487.9

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.

Example: false

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 date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

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"
  }
}

Criar empréstimo

/v1/loans

Request​

Query Parameters

Header Parameters

Body

Responses​

Request

Responses