List loans with filtering applied.

🚧

FAQ

This endpoint does not cap results. However we recommend using date filters appropriate for your portfolio size such that <500 results are returned.

You can filter on status, which will be one of: "Defaulted", "Discounted Settlement", "Funded", "Funded (Pending Settlement)", "Partially Funded", "Repaid", "Requested Funding", "Unfunded", "Written Off"

currentAmount is the balance outstanding.

fundedAmount is the amount that the customer borrowed. Equivalent to youWillGet in the Onboarding API.

originalAmount is the amount that the customer borrowed plus the fee YouLend charged. i.e. the total amount that the customer needs to repay. Equivalent to youWillRepay in the Onboarding API.

Body Params

Search Criteria model

Model used to filter loans.

loanState
array of strings | null

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

loanState
date-time | null

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

date-time | null

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

int32 | null

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

int32 | null

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

string | null

Gets or sets the repayment method filter.

string | null

Gets or sets the third-party customer id filter.

Headers
string
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

204

No loans were found that match the input criteria for the lending partner

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json