Retrieve instant settlement details by instant settlement number

get/api/InstantSettlement/{instantSettlementNumber}

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.

Headers

api-versionstring

Response

Instant settlement details are returned

instantSettlementIdstring uuid

Gets or sets the Instant Settlement Id

instantSettlementNumberinteger

Gets or sets the Instant Settlement number

lenderNamestring nullable

Gets or sets the lender name

borrowerNamestring nullable

Gets or sets the borrower name

currencyISOCodestring nullable

Gets or sets the currency ISO code

merchantIdsstring[] nullable

Gets or sets the merchant IDs

locatorIdstring nullable

Gets or sets the locator Id (customer Id)

autoCreateTransactionsboolean

Gets or sets a value indicating whether the accelerated payout service is active

maxExposurenumber double

Gets or sets the maximum exposure

maxExposureEnabledboolean

Gets or sets a value indicating whether instant settlement loans are capped at the maximum exposure

currentExposurenumber double

Gets or sets the current exposure

percentageToInstantSettlenumber double

Gets or sets the proportion of transaction amounts to instant settle

percentageFeenumber double

Gets or sets the instant settlement fee percentage

initialSettlementCycleDelayDaysnumber double

Gets or sets the delay (number of days) of the initial settlement cycle

settlementCycleLengthDaysnumber double

Gets or sets the settlement cycle length (number of days)

Changes

No recorded changes to this endpoint across all 1 revision of this API.