GET
Recuperar operação de crédito

Authorizations

X-API-KEY
string
header
required

Chave de API obrigatória em todos os endpoints. Envie no header X-API-KEY: <apiKey>.

Path Parameters

id
string<uuid>
required

Identificador primário da operação de crédito.

Response

Objeto Loan.

Operação de crédito contratada. Os campos seguem o esquema do Open Finance Brasil; valores em PT (ex.: EFETIVA, SIMPLES, AA) são passados adiante sem coerção.

id
string
required

Identificador.

itemId
string<uuid>
required

Item ao qual a operação pertence.

productName
string
required

Nome do produto divulgado ao cliente.

kind
enum<string>
required

Categoria da operação.

Available options:
LOAN,
FINANCING,
INVOICE_FINANCING,
UNARRANGED_ACCOUNT_OVERDRAFT
date
string<date-time>
required

Data em que os dados foram coletados.

currencyCode
string
required

Código ISO 4217.

contractNumber
string | null

Número do contrato na instituição.

ipocCode
string | null

IPOC (Identificação Padronizada da Operação de Crédito).

type
string | null

Subtipo de produto de crédito do Open Finance Brasil (ex.: CREDITO_PESSOAL_COM_CONSIGNACAO) — pass-through do enum OFB EnumContractProductSubTypeLoans.

contractDate
string<date-time> | null
disbursementDates
string[] | null

Datas de desembolso.

settlementDate
string<date-time> | null
contractAmount
number | null

Valor contratado.

dueDate
string<date-time> | null
installmentPeriodicity
enum<string> | null

Periodicidade das parcelas.

Available options:
WITHOUT_REGULAR_PERIODICITY,
WEEKLY,
FORTNIGHTLY,
MONTHLY,
BIMONTHLY,
QUARTERLY,
SEMESTERLY,
YEARLY,
OTHERS,
null
installmentPeriodicityAdditionalInfo
string | null

Complemento obrigatório quando a periodicidade é OTHERS.

firstInstallmentDueDate
string<date-time> | null
CET
number | null

Custo Efetivo Total, taxa percentual anual com todos os encargos (nome do campo em MAIÚSCULAS).

amortizationScheduled
enum<string> | null

Sistema de amortização.

Available options:
SAC,
PRICE,
SAM,
WITHOUT_AMORTIZATION_SYSTEM,
OTHERS,
null
amortizationScheduledAdditionalInfo
string | null

Obrigatório quando OTHERS.

cnpjConsignee
string | null

CNPJ do consignante.

interestRates
object[] | null
contractedFees
object[] | null
contractedFinanceCharges
object[] | null
warranties
object[] | null
installments
object | null

Resumo das parcelas da operação.

payments
object | null

Pagamentos realizados na operação.