Sign in

v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
InstantSettlement

List transactions for an instant settlement

Sample request:

GET /transactions?Count=20&TimeFilterMin=2020-06-10T09:28:54Z&TimeFilterMax=2020-06-17T09:28:54Z&SortProperty=DateCreated&SortReverse=true
get/api/InstantSettlement/{instantSettlementNumber}/transactions

Path parameters

instantSettlementNumberinteger required

Instant settlement number (an integer)<br /><br /> This parameter can be obtained by calling the api/InstantSettlement GET endpoint which returns details about all instant settlement products available for a lending partner.

Query parameters

Countinteger

Gets or sets the maximum number of transactions to return.

Gets or sets the maximum number of transactions to return.

TimeFilterMinstring date-time

Gets or sets the start of the dateCreated time range of transactions to return. Format: ISO 8601. Example: 2020-06-10T09:28:54Z.

Gets or sets the start of the dateCreated time range of transactions to return. Format: ISO 8601. Example: 2020-06-10T09:28:54Z.

TimeFilterMaxstring date-time

Gets or sets the end of the dateCreated time range of transactions to return. Format: ISO 8601. Example: 2020-06-17T09:28:54Z.

Gets or sets the end of the dateCreated time range of transactions to return. Format: ISO 8601. Example: 2020-06-17T09:28:54Z.

SortProperty'InstantSettlementTransactionNumber' | 'InstantSettlementId' | 'Status' | 'DateCreated' | 'DateFunded' | 'DateRepaid' | 'CurrentAmount' | 'FundedAmount' | 'Amount' | 'AmountAfterFees'

Gets or sets the sort property of transactions to return. You can sort by any property of a transaction. The default is InstantSettlementTransactionNumber.

SortReverseboolean

Gets or sets a value indicating whether to return transactions in ascending (false) or descending (true) order.

Gets or sets a value indicating whether to return transactions in ascending (false) or descending (true) order.

Headers

api-versionstring

Response

Instant settlement transactions are returned

instantSettlementIdstring uuid

Gets or sets the Instant Settlement Id

instantSettlementTransactionNumberinteger

Gets or sets the Instant Settlement Number

status'Funded' | 'Unfunded' | 'Repaid'
dateCreatedstring date-time

Gets or sets the date the loan was created

dateFundedstring date-time

Gets or sets the date the loan was funded

dateRepaidstring date-time

Gets or sets the date the loan was repaid

currentAmountnumber double

Gets or sets the current amount outstanding for the loan

fundedAmountnumber double

Gets or sets the originally funded amount for the loan

amountnumber double

Gets or sets the actual loan amount

amountAfterFeesnumber double

Gets or sets the actual loan amount after fees have been subtracted

requestedAmountnumber double

Gets or sets the amount requested for funding for the loan, before dilution is applied

percentageToInstantSettlenumber double

Gets or sets the dilution (percentage of the YL.Web.Api.ThirdParty.Loan.InstantSettlement.Models.InstantSettlementTransactionModel.RequestedAmount that is actually funded)

maxExposurenumber double

Gets or sets the Maximum Exposure at the time of loan creation