Loans
Get loan
Get loan by ID.
get/rest/loans/{loan-id}
Path parameters
loan-idstring required
finX ID of the loan.
Example:L12345.6
Response
Loan details.
idSchema required— unresolved $ref
access_idSchema required— unresolved $ref
namestring required
Name of the loan product.
type'BUSINESS' | 'PERSONAL' | 'MORTGAGE' required
The type of the loan indicating its usage.
reference_idstring required
Reference or identification code for the loan product as provided by the bank.
linked_accountstring
Identification of the account from which the installments are deducted. This is usually an IBAN.
currencystring ISO 4217:2015 required
Three-letter currency code.
principalnumber float required
The original amount of money that was agreed to borrow.
balancenumber float required
The amount of of money that is still owed to the lender. This is usually a negative value.
matures_onSchema required— unresolved $ref
next_payment_onSchema — unresolved $ref
next_payment_amountnumber float
The money amount to be paid with the next installment.
last_payment_onSchema — unresolved $ref
last_payment_amountnumber float
The money amount that was paid with the last installment.
created_atCreatedAt required— unresolved $ref
modified_atModifiedAt required— unresolved $ref