Upvest · Schema

Withdrawal

A cash withdrawal from an investment account.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
id string The withdrawal identifier.
account_id string The account to withdraw from.
cash_amount string The withdrawal amount.
currency string The currency of the withdrawal.
status string The withdrawal status.
created_at string When the withdrawal was created.
View JSON Schema on GitHub

JSON Schema

investment-api-withdrawal-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-schema.json",
  "title": "Withdrawal",
  "description": "A cash withdrawal from an investment account.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The withdrawal identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "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 of the withdrawal.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "status": {
      "type": "string",
      "enum": [
        "NEW",
        "PROCESSING",
        "COMPLETED",
        "FAILED"
      ],
      "description": "The withdrawal status.",
      "example": "NEW"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the withdrawal was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}