Sign in

v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
InstantSettlement

List daily settlement activity entries for an instant settlement

Sample request:

GET /dailysettlementactivity?TimeFilterMin=2020-06-10&TimeFilterMax=2020-06-17&SortProperty=Date&SortReverse=true
get/api/InstantSettlement/{instantSettlementNumber}/dailysettlementactivity

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 daily settlement activity entries to return.

Gets or sets the maximum number of daily settlement activity entries to return.

TimeFilterMinstring date-time

Gets or sets the start date for daily settlement activity entries to return. Format: ISO 8601. Example: 2020-06-10.

Gets or sets the start date for daily settlement activity entries to return. Format: ISO 8601. Example: 2020-06-10.

TimeFilterMaxstring date-time

Gets or sets the end date for daily settlement activity entries to return. Format: ISO 8601. Example: 2020-06-17.

Gets or sets the end date for daily settlement activity entries to return. Format: ISO 8601. Example: 2020-06-17.

SortProperty'Date' | 'FundedAmount' | 'OutstandingInstantSettlement' | 'RequestedAmount' | 'SettlementPassedThrough' | 'SettlementReceived' | 'StartOfDayOutstandingInstantSettlement'

Gets or sets the sort property of daily settlement activity entries to return. You can sort by any of the properties. The default is Date.

SortReverseboolean

Gets or sets a value indicating whether to return daily settlement activity entries in ascending (false) or descending (true) order.

Gets or sets a value indicating whether to return daily settlement activity entries in ascending (false) or descending (true) order.

Headers

api-versionstring

Response

Instant settlement transactions are returned

datestring date-time

Gets or sets the date of the daily settlement activity entry

startOfDayOutstandingInstantSettlementnumber double

Gets or sets the outstanding amount of the instant settlement at the start of the specified Date

requestedAmountnumber double

Gets or sets the amount to settle requested by the merchant for the specified Date

fundedAmountnumber double

Gets or sets the amount funded for the specified Date

settlementReceivednumber double

Gets or sets the settlement amount received and used to repay the outstanding balance for the specified Date

settlementPassedThroughnumber double

Gets or sets the settlement amount that has been redirected to the merchant's account and has not been used to repay any outstanding balance for the specified Date

outstandingInstantSettlementnumber double

Gets or sets the current outstanding amount of the instant settlement for the specified Date