Initiate an incoming transfer

post

https://broker-api.sandbox.alpaca.markets/v1beta1/acats/{account_id}

This endpoint allows you to create new incoming ACATS requests. We currently support full and partial transfer types, for US equities and cash. Note that after submitting a request, it might take some time for the transfer to show up on the other endpoints. Transfers are not immediately sent to DTCC, and will appear in the PENDING state initially.

Path Params

account_id

uuid

required

Account ID associated with the ACATS transfer

Body Params

Details of the incoming ACATS transfer to initiate.

Request body for initiating an incoming ACATS transfer.

contra_account_details

object

required

Contra account details

ip_address

string

required

IP address from which the account holder initiated the transfer (IPv4 or IPv6)

signed_at

date-time

required

Timestamp at which the account holder signed/authorized the transfer. Must be within the last week and must not be in the future (a 5 minute grace period absorbs clock skew); values outside that window are rejected with HTTP 400.

transfer_details

required

Transfer details. The two transfer types are mutually exclusive in what they accept:

FULL: do not include the cash or securities objects (the entire account will be transferred). Including either is rejected with HTTP 400.
PARTIAL: specify which assets to transfer using the cash and/or securities objects. At least one of the two must be present and non-empty, otherwise the request is rejected with HTTP 400.

validate_account_number

boolean

Defaults to false

Whether to validate the contra account number against the contra broker's configured format rules. Defaults to false (no per-broker format check). Set to true to opt in, in which case a number that matches none of the broker's enabled rules is rejected with HTTP 422.

Responses

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

202Accepted

400Bad Request

403Forbidden

500Internal Server Error