Transfer

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/alpaca/json-schema/alpaca-transfer-schema.json",
  "title": "Transfer",
  "description": "Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal).\n\n[Main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#the-transfer-object)",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/alpaca-accounts-api-openapi.yml#/components/schemas/Transfer",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The transfer ID"
    },
    "relationship_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ACH relationship ID only present if type = \"ach\""
    },
    "bank_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the Bank, only present if type = \"wire\""
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account ID"
    },
    "type": {
      "$ref": "#/$defs/TransferType"
    },
    "status": {
      "$ref": "#/$defs/TransferStatus"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cause of the status"
    },
    "amount": {
      "type": "string",
      "description": "Must be > 0.00",
      "format": "decimal"
    },
    "direction": {
      "$ref": "#/$defs/TransferDirection"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timedate when transfer was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timedate when transfer was updated"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timedate when transfer was expired"
    },
    "additional_information": {
      "type": [
        "string",
        "null"
      ],
      "description": "Additional information. Only applies when type = \"wire\"."
    },
    "hold_until": {
      "type": "string",
      "format": "date-time"
    },
    "instant_amount": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "account_id",
    "type",
    "status",
    "amount",
    "direction",
    "created_at"
  ],
  "$defs": {
    "TransferDirection": {
      "type": "string",
      "enum": [
        "INCOMING",
        "OUTGOING"
      ],
      "description": "- **INCOMING**\nFunds incoming to user’s account (deposit).\n- **OUTGOING**\nFunds outgoing from user’s account (withdrawal).\n"
    },
    "TransferStatus": {
      "type": "string",
      "enum": [
        "QUEUED",
        "APPROVAL_PENDING",
        "PENDING",
        "SENT_TO_CLEARING",
        "REJECTED",
        "CANCELED",
        "APPROVED",
        "COMPLETE",
        "RETURNED"
      ],
      "description": "- **QUEUED**\nTransfer is in queue to be processed.\n- **APPROVAL_PENDING**\nTransfer is pending approval.\n- **PENDING**\nTransfer is pending processing.\n- **SENT_TO_CLEARING**\nTransfer is being processed by the clearing firm.\n- **REJECTED**\nTransfer is rejected.\n- **CANCELED**\nClient initiated transfer cancellation.\n- **APPROVED**\nTransfer is approved.\n- **COMPLETE**\nTransfer is completed.\n- **RETURNED**\nThe bank issued an ACH return for the transfer.\n"
    },
    "TransferType": {
      "type": "string",
      "enum": [
        "ach",
        "instant_ach",
        "wire"
      ],
      "description": "**NOTE:** The Sandbox environment currently only supports `ach`\n\n- **ach**\nTransfer via ACH (US Only).\n- **wire**\nTransfer via wire (international).\n",
      "title": "TransferType"
    }
  }
}