Request a New Transfer

post

https://broker-api.sandbox.alpaca.markets/v1/accounts/{account_id}/transfers

Create a new transfer to deposit money into or withdraw money from an account.

Two transfer_type values are accepted, and both are available in sandbox and production:

ach — supports both INCOMING (deposit) and OUTGOING (withdrawal) directions. A relationship_id from a previously created ACH Relationship is required.
wire — supports the OUTGOING (withdrawal) direction only. Incoming wires cannot be initiated through this endpoint; they are pushed in by the sending bank and recorded automatically. A bank_id from a previously created Bank Relationship is required, and the bank must be in APPROVED status before the transfer will progress past QUEUED.

In the sandbox environment, ACH deposits and withdrawals settle instantly against virtual funds. Outgoing wire withdrawals are accepted and simulated end-to-end — no funds are transmitted to a bank, but the transfer progresses to COMPLETE and the account is debited against virtual funds. Sandbox wire withdrawals are asynchronous (not instant) and auto-complete on weekdays only; transfers submitted on a weekend will not progress until Monday. For more on funding accounts in sandbox, see this tutorial.

Path Params

account_id

uuid

required

Body Params

See main docs here

additional_information

string | null

Additional details for when type = wire

amount

string

required

Must be > 0.00

bank_id

uuid

Required if type = wire

The bank_relationship created for the account_id here

direction

string

enum

required

INCOMING Funds incoming to user's account (deposit).
OUTGOING Funds outgoing from user's account (withdrawal).

Allowed:

fee_payment_method

string

Only outgoing wire fees are currently supported for automated processing.

user The end user will pay any applicable fees invoice Any applicable fees will be billed to the client in the following monthly invoice

ira

object

This field is used for IRA Account only

relationship_id

uuid

Required if type = ach

The ach_relationship created for the account_id here

timing

string

enum

deprecated

Deprecated. Not honored by the API; values sent are silently ignored and this field will be removed.

Allowed:

transfer_type

string

enum

required

ach Transfer via ACH (US Only). Supports both INCOMING (deposit) and OUTGOING (withdrawal) directions.
wire Transfer via wire. OUTGOING (withdrawal) only.

Allowed:

Responses

200Successfully requested a transfer.

400The request body is malformed (e.g. invalid JSON).

403The account is not permitted to perform this transfer. Examples include: deposits are not permitted for this account — the account's depositable_status is not allowed / limited. withdrawals are not permitted for this account — the account's withdrawable_status is not allowed / limited.