CreateTransferRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/alpaca/json-schema/alpaca-create-transfer-request-schema.json",
  "title": "CreateTransferRequest",
  "description": "[See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#creating-a-transfer-entity)",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/alpaca-funding-api-openapi.yml#/components/schemas/CreateTransferRequest",
  "type": "object",
  "properties": {
    "transfer_type": {
      "$ref": "#/$defs/TransferType"
    },
    "relationship_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required if type = `ach`\n\nThe ach_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/ach/#creating-an-ach-relationship)"
    },
    "bank_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required if type = `wire`\n\nThe bank_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/bank/#creating-a-new-bank-relationship)"
    },
    "amount": {
      "type": "string",
      "format": "decimal",
      "description": "Must be > 0.00"
    },
    "direction": {
      "$ref": "#/$defs/TransferDirection"
    },
    "timing": {
      "$ref": "#/$defs/TransferTiming"
    },
    "additional_information": {
      "type": [
        "string",
        "null"
      ],
      "description": "Additional details for when type = `wire`"
    }
  },
  "required": [
    "transfer_type",
    "amount",
    "direction",
    "timing"
  ],
  "$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"
    },
    "TransferTiming": {
      "type": "string",
      "enum": [
        "immediate"
      ],
      "description": "Only `immediate` is currently supported.\n\nvalues:\n\n- **immediate**\n\n- **next_day**"
    },
    "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"
    }
  }
}