---
updatedAt: 2025-05-15T21:03:20.000Z
agentTools:
  projectIndex: https://docs.youlend.com/llms.txt
---

# List instant settlements for a lending partner

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "YouLend Third Party Instant Settlement API",
    "description": "Through this API you can can create Instant Settlement transactions with YouLend",
    "contact": {
      "name": "Mark Ufland",
      "email": "mark.ufland@youlend.com"
    },
    "version": "v1.0"
  },
  "servers": [
    {
      "url": "https://partners.staging-youlendapi.com/instantsettlement"
    }
  ],
  "paths": {
    "/api/InstantSettlement": {
      "get": {
        "tags": [
          "InstantSettlement"
        ],
        "summary": "List instant settlements for a lending partner",
        "parameters": [
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Instant settlements for a lending partner are returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/InstantSettlementView"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Something went wrong!"
          },
          "401": {
            "description": "Unauthorized request"
          },
          "500": {
            "description": "Servers are unavailable"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "InstantSettlementView": {
        "type": "object",
        "properties": {
          "instantSettlementId": {
            "type": "string",
            "description": "Gets or sets the Instant Settlement Id",
            "format": "uuid"
          },
          "instantSettlementNumber": {
            "type": "integer",
            "description": "Gets or sets the Instant Settlement number",
            "format": "int32"
          },
          "lenderName": {
            "type": "string",
            "description": "Gets or sets the lender name",
            "nullable": true
          },
          "borrowerName": {
            "type": "string",
            "description": "Gets or sets the borrower name",
            "nullable": true
          },
          "currencyISOCode": {
            "type": "string",
            "description": "Gets or sets the currency ISO code",
            "nullable": true
          },
          "merchantIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Gets or sets the merchant IDs",
            "nullable": true
          },
          "locatorId": {
            "type": "string",
            "description": "Gets or sets the locator Id (customer Id)",
            "nullable": true
          },
          "settlementCycleLengthDay": {
            "type": "integer",
            "description": "Gets or sets the settlement cycle length (number of days)",
            "format": "int32"
          },
          "currentExposure": {
            "type": "number",
            "description": "Gets or sets the current exposure",
            "format": "double"
          },
          "maxExposureEnabled": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether instant settlement loans are capped at the maximum exposure"
          },
          "maxExposure": {
            "type": "number",
            "description": "Gets or sets the maximum exposure",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "Model for viewing a summary of an Instant Settlement"
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://youlend-stag.eu.auth0.com/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```