v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB

Loans

List loans with filtering applied.

get/Loans/allLoans/filter

Headers

api-versionstring

Request body

loanStatestring[] nullable

Gets or sets the list of loan status to filter by.

dateFromstring date-time nullable

Gets or sets DateFrom, the funding date in YYYY-MM-DD HH:mm:ss.

dateTostring date-time nullable

Gets or sets DateTo, the funding date in YYYY-MM-DD HH:mm:ss.

indexinteger nullable

Gets or sets the pagination index (default: 0).

countinteger nullable

Gets or sets the pagination count (default: 500).

repaymentMethodstring nullable

Gets or sets the repayment method filter.

thirdPartyCustomerIdstring nullable

Gets or sets the third-party customer id filter.

Response

Request processed successfully

ownerstring nullable

Gets or sets the company that owns the loan

thirdPartyCustomerIdstring nullable

Gets or sets the TPCI associated with the loan

additionalInfoobject nullable

Gets or sets additional info associated with the loan, this is in a key value pair format

leadIdstring uuid

Gets or sets the lead id associated with the loan

countryISOCodestring nullable

Gets or sets the registered country iso code of the borrower.

emailstring nullable

Gets or sets the registered email of the borrower.

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 associated with the loan.

idstring uuid

Gets or sets the loan's unique identifier

loanNumberinteger

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

borrowerNamestring nullable

Gets or sets the borrower's name

currentAmountnumber double

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

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"

maturityDatestring date-time

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

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

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

currencyISOCodestring nullable

Gets or sets the loan's Currency ISO Code, e.g. "GBP"

currentAmountAtRepaynumber double

Gets or sets the Current Amount at the time of full loan repayment, if applicable

currentAmountAtDeletenumber double

Gets or sets the Current Amount at the time of loan deletion, if applicable

currentAmountAtWriteOffnumber double

Gets or sets the Current Amount at the time of loan write-off, if applicable

merchantIdsstring[] nullable

Gets or sets the associated MIDs

creditRatingstring nullable

Gets or sets the Credit Rating

fundingDatestring date-time

Gets or sets the funding date

fundedAmountnumber double

Gets or sets the funding amount

originalAmountnumber double

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

aheadBehindValuenumber double

Gets or sets how far ahead/behind the loan repayments are from the expected amount

aheadBehindPercentagenumber double

Gets or sets how far ahead/behind the actual average payments are from the average expected payments as a percentage

contractTypestring nullable

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