---
updatedAt: 2026-04-30T10:28:01.000Z
agentTools:
  projectIndex: https://developer.sivo.com/llms.txt
---

# List yield accounts

Returns a list of yieldaccounts

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Banking",
    "description": "SIVO public Api REST",
    "version": "0.0.1"
  },
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "servers": [
    {
      "url": "https://dev.sivo.com/v1",
      "description": "Sandbox server (user test data)"
    }
  ],
  "paths": {
    "/lending/yield-accounts": {
      "get": {
        "summary": "List yield accounts",
        "description": "Returns a list of yieldaccounts",
        "operationId": "getLendingYieldAccount",
        "tags": [
          "Yield Management"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/yieldAccount"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input supplied"
          },
          "404": {
            "description": "YieldAccount not found"
          }
        },
        "security": [
          {
            "prod-sandbox-sivo-api-authorizer": [
              "aws.cognito.signin.user.admin"
            ]
          }
        ],
        "x-amazon-apigateway-integration": {
          "httpMethod": "POST",
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/${Token[TOKEN.2317]}:Alias/invocations"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "uuid": {
        "type": "string",
        "description": "A universal identifier (all lowercase)",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "currencyIso4217": {
        "type": "string",
        "description": "A currency identifier in ISO-4217 format",
        "pattern": "^[A-Z]{3}$"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "integer": {
        "type": "integer",
        "minimum": 0,
        "maximum": 2147483647
      },
      "jsonValue": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "string"
          },
          {
            "$ref": "#/components/schemas/jsonObject"
          },
          {
            "$ref": "#/components/schemas/jsonArray"
          }
        ],
        "description": "A JSON value: https://en.wikipedia.org/wiki/JSON"
      },
      "jsonArray": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/jsonValue"
        },
        "description": "A JSON array: https://en.wikipedia.org/wiki/JSON"
      },
      "yieldStatus": {
        "type": "string",
        "enum": [
          "disabled"
        ]
      },
      "interestLedger": {
        "type": "string",
        "enum": [
          "receivable",
          "principal"
        ]
      },
      "sivoYieldTerms": {
        "type": "object",
        "properties": {
          "interest_due_day": {
            "$ref": "#/components/schemas/dayOfMonth"
          },
          "interest_ledger": {
            "$ref": "#/components/schemas/interestLedger"
          },
          "interest": {
            "$ref": "#/components/schemas/interestRatePercentAmounttbqr"
          },
          "currency": {
            "$ref": "#/components/schemas/currencyIso4217"
          }
        },
        "required": [
          "interest_due_day",
          "interest_ledger",
          "interest",
          "currency"
        ],
        "additionalProperties": false
      },
      "dayOfMonth": {
        "type": "integer",
        "description": "A day of the month, between 1 and 31",
        "minimum": 1,
        "maximum": 31
      },
      "percentAmount": {
        "type": "number",
        "description": "Should be a value between 0 and 1. For example, 0.05 represents 5%",
        "minimum": -10,
        "maximum": 10
      },
      "otherableBaseRateType": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "value": {
                "$ref": "#/components/schemas/baseRateType"
              }
            },
            "required": [
              "value"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "enum": [
                  "other"
                ]
              },
              "other": {
                "$ref": "#/components/schemas/text"
              }
            },
            "required": [
              "value",
              "other"
            ],
            "additionalProperties": false
          }
        ]
      },
      "yieldAccount": {
        "type": "object",
        "properties": {
          "originator_id": {
            "$ref": "#/components/schemas/uuid"
          },
          "name": {
            "$ref": "#/components/schemas/text"
          },
          "status": {
            "$ref": "#/components/schemas/yieldStatus"
          },
          "lock_months": {
            "$ref": "#/components/schemas/integer"
          },
          "sivo_terms": {
            "$ref": "#/components/schemas/sivoYieldTerms"
          },
          "metadata": {
            "$ref": "#/components/schemas/jsonObjectjxu8"
          }
        },
        "required": [
          "originator_id",
          "name",
          "lock_months"
        ],
        "additionalProperties": false
      },
      "interestRatePercentAmounttbqr": {
        "type": "object",
        "discriminator": {
          "propertyName": "type"
        },
        "required": [
          "type"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/fixedInterestRatePercentAmountf8la"
          },
          {
            "$ref": "#/components/schemas/variableInterestRatePercentAmount7gc9"
          }
        ]
      },
      "fixedInterestRatePercentAmountf8la": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "fixed"
            ]
          },
          "rate": {
            "$ref": "#/components/schemas/percentAmount"
          }
        },
        "required": [
          "type",
          "rate"
        ],
        "additionalProperties": false
      },
      "variableInterestRatePercentAmount7gc9": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "variable"
            ]
          },
          "base_rate": {
            "$ref": "#/components/schemas/otherableBaseRateType"
          },
          "rate_margin": {
            "$ref": "#/components/schemas/percentAmount"
          }
        },
        "required": [
          "type",
          "base_rate",
          "rate_margin"
        ],
        "additionalProperties": false
      },
      "jsonObjectjxu8": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/jsonValue"
        },
        "description": "A JSON object: `https://en.wikipedia.org/wiki/JSON`"
      },
      "jsonObject": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/jsonValue"
        },
        "description": "A JSON object: `https://en.wikipedia.org/wiki/JSON`"
      },
      "baseRateType": {
        "type": "string",
        "enum": [
          "us_prime",
          "us_fed_funds",
          "us_sofr",
          "libor"
        ]
      }
    },
    "securitySchemes": {
      "prod-sandbox-sivo-api-authorizer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-amazon-apigateway-authtype": "cognito_user_pools",
        "x-amazon-apigateway-authorizer": {
          "type": "cognito_user_pools",
          "providerARNs": [
            "${Token[TOKEN.1762]}"
          ]
        }
      }
    }
  },
  "x-amazon-apigateway-minimum-compression-size": 0
}
```