v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB

Loans

Retrieve a loan by loan id

get/Loans/{loanId}

Path parameters

loanIdstring uuid required

Loan ID (a GUID)

Headers

api-versionstring

Response

Loan successfully retrieved

repaymentMethodstring nullable

Gets or sets the loan's repayment method.

repaymentFrequencystring nullable

Gets or sets the loan's repayment frequency - can be null when repayment method not Direct Debit or VRP.

expectedRepaymentnumber double

Gets or sets the loan's expected repayment amount - return 0 when frequency null.

productTypestring nullable

Gets or sets the product type.

autoRepaymentSweepboolean

Gets or sets a value indicating whether an Auto Repayment Sweep is to be used - this feature automatically directs a chosen proportion, the Sweep, of transaction income towards repaying the loan.

borrowerIdstring uuid

Gets or sets the Borrower ID.

borrowerNamestring nullable

Gets or sets the Borrower Name.

currencyISOCodestring nullable

Gets or sets the Currency ISO Code.

currentAmountnumber double

Gets or sets the Current Amount, the amount yet to be repaid.

currentServiceChargeRatenumber double

(DEPRECATED).

discountnumber double

Gets or sets the loan's discount rate.

idstring uuid

Gets or sets the loan's unique identifier.

approvalDatestring date-time

(DEPRECATED).

maturityDatestring date-time

Gets or sets the date on which the loan is due to mature, and by which it should be fully repaid.

originalAmountnumber double

Gets or sets the Original Amount, the total amount due to be repaid on maturity.

originalServiceChargeRatenumber double

(DEPRECATED).

projectedRepaymentDatestring date-time

Gets or sets the Projected Repayment Date.

securityAndGuaranteesboolean

(DEPRECATED).

loanTypestring nullable

Gets or sets the Loan Type - "Initial", "Early Renewal" or "Renewal".

partnerLoanTypestring nullable

Gets or sets the Partner Loan Type - "Initial", "Early Renewal" or "Renewal".

statusstring nullable

Gets or sets the loan's Status - "Defaulted", "Discounted Settlement", "Funded", "Funded (Pending Settlement)", "Partially Funded", "Repaid", "Requested Funding", "Unfunded", "Written Off".

sweepnumber double

Gets or sets the Sweep, the decimal out of 100 representing the proportion of transaction income to be used to repay the loan.

loanNumberinteger

Gets or sets the Loan Number, an ordinal value indicating which of a customer's loans is here detailed.

creditRatingstring nullable

Gets or sets the Credit Rating.

contractTypestring nullable

Gets or sets the agreement contract type ("RPA" / "LA") if available.