Upvest · Schema

WithdrawalCreate

Request body for creating a withdrawal.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
account_id string The account to withdraw from.
cash_amount string The withdrawal amount.
currency string The currency as an ISO 4217 code.
View JSON Schema on GitHub

JSON Schema

investment-api-withdrawal-create-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-withdrawal-create-schema.json",
  "title": "WithdrawalCreate",
  "description": "Request body for creating a withdrawal.",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account to withdraw from.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "cash_amount": {
      "type": "string",
      "description": "The withdrawal amount.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The currency as an ISO 4217 code.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    }
  },
  "required": [
    "account_id",
    "cash_amount",
    "currency"
  ]
}