Upvest · Schema

Transaction

A transaction record within an account.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
id string The transaction identifier.
account_id string The account the transaction belongs to.
type string The transaction type.
amount string The transaction amount as a decimal string.
currency string The transaction currency.
created_at string When the transaction occurred.
View JSON Schema on GitHub

JSON Schema

investment-api-transaction-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-transaction-schema.json",
  "title": "Transaction",
  "description": "A transaction record within an account.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The transaction identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account the transaction belongs to.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "type": {
      "type": "string",
      "enum": [
        "ORDER_EXECUTION",
        "FEE",
        "DIVIDEND",
        "TRANSFER",
        "DIRECT_DEBIT",
        "WITHDRAWAL"
      ],
      "description": "The transaction type.",
      "example": "ORDER_EXECUTION"
    },
    "amount": {
      "type": "string",
      "description": "The transaction amount as a decimal string.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The transaction currency.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the transaction occurred.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}