---
title: "List instant settlements by locator id"
method: GET
path: "/api/InstantSettlement/locators/{locatorId}/instantsettlements"
tags: ["InstantSettlement"]
---

# List instant settlements by locator id

`GET /api/InstantSettlement/locators/{locatorId}/instantsettlements`

## Request

- Base URL: `https://partners.staging-youlendapi.com/instantsettlement`
- URL: `https://partners.staging-youlendapi.com/instantsettlement/api/InstantSettlement/locators/{locatorId}/instantsettlements`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://youlend-stag.eu.auth0.com/oauth/token`

## Path parameters

- `locatorId` string, required

## Headers

- `api-version` string

## Response `200`

Instant settlements for the locator id are returned

- InstantSettlementView[]
  - `instantSettlementId` string, uuid: Gets or sets the Instant Settlement Id
  - `instantSettlementNumber` integer: Gets or sets the Instant Settlement number
  - `lenderName` string, nullable: Gets or sets the lender name
  - `borrowerName` string, nullable: Gets or sets the borrower name
  - `currencyISOCode` string, nullable: Gets or sets the currency ISO code
  - `merchantIds` string[], nullable: Gets or sets the merchant IDs
  - `locatorId` string, nullable: Gets or sets the locator Id (customer Id)
  - `settlementCycleLengthDay` integer: Gets or sets the settlement cycle length (number of days)
  - `currentExposure` number, double: Gets or sets the current exposure
  - `maxExposureEnabled` boolean: Gets or sets a value indicating whether instant settlement loans are capped at the maximum exposure
  - `maxExposure` number, double: Gets or sets the maximum exposure

## Other responses

- `400`: Something went wrong!
- `401`: Unauthorized request
- `500`: Servers are unavailable

---

[API](https://skmtc.dev/youlend/apis/youlend-third-party-instant-settlement-api.md) - [All operations](https://skmtc.dev/youlend/apis/youlend-third-party-instant-settlement-api/llms.txt) - [OpenAPI document](https://skmtc.dev/youlend/apis/youlend-third-party-instant-settlement-api/revisions/68784baa0d13?raw)