Request a New Transfer

post

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

Create a new transfer to an account to fund it.

In the sandbox environment, you can instantly deposit to or withdraw from an account with a virtual money amount. In the production environment, this endpoint is used only for requesting an outgoing (withdrawal) wire transfer at this moment. For the wire transfer (in production), you need to create a bank resource first using the Bank API. For more on how to fund an account in sandbox please check out this tutorial here.

Path Params

account_id

uuid

required

Body Params

transfer_type

string

enum

required

NOTE: The Sandbox environment currently only supports ach

ach
Transfer via ACH (US Only).
wire
Transfer via wire (international).

Allowed:

relationship_id

uuid

Required if type = ach

The ach_relationship created for the account_id here

bank_id

uuid

Required if type = wire

The bank_relationship created for the account_id here

amount

string

required

Must be > 0.00

direction

string

enum

required

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

Allowed:

timing

string

enum

required

Only immediate is currently supported.

values:

immediate
next_day

Allowed:

additional_information

string | null

Additional details for when type = wire

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

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully requested a transfer.