Alterar o estado de um empréstimo para aberto

Altera o estado de um empréstimo para aberto.

Authorizations

Authorization

string

header

required

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

Descrição do motivo da atualização do estado.

description

string

Erro ao salvar no parceiro

Response

200 - application/json

Este objeto representa um empréstimo.

amountForPayment

number

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

amountRemaining

number

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

attachments

object[]

Show child attributes

attachments.file

string

attachments.linkedAt

string

cashout

object[]

• CashoutTransfer
• CashoutBoleto
• CashoutInvoice
• CashoutBoleto

Show child attributes

cashout.amount

number

required

cashout.paymentMethod

string

required

cashout.type

string

default:

payment_method

required

company

string

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

context

object

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

Show child attributes

context.fingerprint

string

context.geolocation

string[]

context.headers

object

context.ip

string

contractNumber

string

Número do contrato

createdAt

string

Data de criação do objeto

customer

string

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

deleted

boolean

default:

false

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

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.

externalId

string

history

object[]

Show child attributes

history.createdAt

string

Data de criação do objeto

history.description

string

history.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.

history.status

string

default:

open

Status do empréstimo

id

string

Identificador exclusivo para o objeto.

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.

offer

object

Este objeto representa uma oferta de um empréstimo.

Show child attributes

offer.cashout

object[]

• CashoutTransfer
• CashoutBoleto
• CashoutInvoice
• CashoutBoleto

Show child attributes

offer.cashout.amount

number

required

offer.cashout.paymentMethod

string

required

offer.cashout.type

string

default:

payment_method

required

offer.createdAt

string

Data de criação do objeto

offer.creditOperationType

string

Tipo de operação de crédito

offer.creditPolicy

string

Política de crédito utilizada para a oferta

offer.description

string

offer.disbursementAmount

number

Valor solicitado

offer.expectedDisbursementDate

string

Data de desembolso no padrão ISO 8601

offer.fine

object

Definição de multa.

Show child attributes

offer.fine.fineRate

number

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

offer.fine.interestBase

enum<string>

Contagem do tempo para multa (calendar para dias corridos e workdays para dias úteis)

Available options:

workdays,

calendarDays

offer.fine.monthlyRate

number

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

offer.firstDueDate

string

Data do primeiro vencimento

offer.fund

string

Identificador que faz referência a um fundo.

offer.id

string

Identificador exclusivo para o objeto.

offer.installmentAmount

number

Valor da parcela.

offer.insurance

object

Definição do seguro vinculado a oferta de empréstimo.

Show child attributes

offer.insurance.amount

number

offer.insurance.fee

number

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

offer.insurance.insurer

string

offer.insurance.number

string

offer.insurance.type

enum<string>

Available options:

required,

optional,

uninsured

offer.interestAmount

number

Valor total dos Juros.

offer.interestGracePeriod

integer

offer.interestType

string

Tipo de juros aplicado na dívida.

offer.iofAdditionalAmount

number

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

offer.iofAmount

number

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

offer.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.

offer.monthlyCET

number

Custo efetivo total ao mês. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

offer.monthlyFee

number

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

offer.numberOfInstallments

integer

offer.principalGracePeriod

integer

offer.product

string

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

offer.rebates

object[]

Show child attributes

offer.rebates.amount

number

required

Valor da tarifa.

offer.rebates.amountType

enum<string>

required

Tipo do valor a ser cobrado

Available options:

absolute,

percentage

offer.rebates.feeType

enum<string>

required

Tipo da tarifa.

registration: utilizado para indicar tarifas ou taxas de manutenção. tac: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC).

Available options:

tac,

spread,

registration

offer.rebates.description

string

Descrição para a tarifa.

offer.totalAmount

number

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

offer.yearlyCET

number

Custo efetivo total ao ano. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.a.

offer.yearlyFee

number

Taxa anual. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.m.

signatures

object[]

Show child attributes

signatures.context

object

Show child attributes

signatures.context.context

object

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

Show child attributes

signatures.context.context.fingerprint

string

signatures.context.context.geolocation

string[]

signatures.context.context.headers

object

signatures.context.context.ip

string

signatures.context.id

string

Identificador exclusivo para o objeto.

signatures.context.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.

signatures.context.signedAt

string

signatures.signer

string

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

status

string

default:

open

Status do empréstimo

transactions

object[]

Show child attributes

transactions.amount

number

required

transactions.createdAt

string

transactions.description

string

updatedAt

string

Data de alteração do objeto