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

# Withdraw

Submit withdrawal

# 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/{id}/withdraw": {
      "post": {
        "summary": "Withdraw",
        "description": "Submit withdrawal",
        "operationId": "postLendingYieldAccountsWithdraw",
        "tags": [
          "Yield Management"
        ],
        "requestBody": {
          "description": "Create a withdraw",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/withdrawalRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/withdrawalResponse"
                }
              }
            }
          },
          "405": {
            "description": "Invalid input"
          }
        },
        "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"
        },
        "parameters": [
          {
            "in": "path",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            },
            "name": "id",
            "description": "ID of the YieldAccounts"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "moneyAmount": {
        "type": "integer",
        "description": "See [Money](https://developer.sivo.com/reference/money) for details"
      },
      "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}$"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "dateIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date"
      },
      "withdrawalStatus": {
        "type": "string",
        "enum": [
          "success",
          "submitted"
        ]
      },
      "withdrawalRequest": {
        "type": "object",
        "properties": {
          "amount": {
            "$ref": "#/components/schemas/moneyAmount"
          },
          "description": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiary_id": {
            "$ref": "#/components/schemas/uuid"
          }
        },
        "required": [
          "amount",
          "description"
        ],
        "additionalProperties": false
      },
      "withdrawalResponse": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuid"
          },
          "withdrawal_request": {
            "$ref": "#/components/schemas/withdrawalRequest"
          },
          "withdrawal_status": {
            "$ref": "#/components/schemas/withdrawalStatus"
          },
          "account_status": {
            "$ref": "#/components/schemas/yieldAccountStatustnlg"
          }
        },
        "required": [
          "id",
          "withdrawal_request",
          "withdrawal_status",
          "account_status"
        ],
        "additionalProperties": false
      },
      "fractionalMoneyAmount": {
        "$ref": "#/components/schemas/double",
        "description": "A monetary amount that supports fractions of the smallest currency denomination. An 8 byte signed floating point number. 15 decimal precision"
      },
      "double": {
        "type": "number",
        "description": "An 8 byte signed floating point number. 15 decimal precision"
      },
      "yieldAccountStatustnlg": {
        "type": "object",
        "properties": {
          "current_balance": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "The current balance of the yield account. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "monthly_interest": {
            "$ref": "#/components/schemas/accruedInterest5zxh",
            "description": "Interest that has been acrued in a given month"
          },
          "outstanding_interest": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "Outstanding interest that has been accrued but not paid. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "paid_interest": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "Total interest charged during the lifetime of the yield account. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "last_accrued": {
            "$ref": "#/components/schemas/dateIso8601",
            "description": "Date of last interest accrual. See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details"
          },
          "accrued_interest": {
            "$ref": "#/components/schemas/fractionalMoneyAmount",
            "description": "Fractional interest that has been accrued in a given interest period. A monetary amount that supports fractions of the smallest currency denomination. An 8 byte signed floating point number. 15 decimal precision"
          }
        },
        "required": [
          "current_balance",
          "monthly_interest",
          "outstanding_interest",
          "paid_interest"
        ],
        "additionalProperties": false,
        "description": "Properties related to the borrowing status of a yield account"
      },
      "accruedInterest5zxh": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/fractionalMoneyAmount"
        }
      }
    },
    "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
}
```