Simulate an Incoming Wire Transfer

post

https://broker-api.sandbox.alpaca.markets/v1/testing/incoming_wires

Simulate an incoming wire transfer to fund one of your accounts, without a real sending bank.

This endpoint is only available in the sandbox environment. Calling it in production returns 403. In production, incoming wires are sent by the customer's bank and cannot be created through the API.

Identify the destination account by including an FFC (For Further Credit) string FFC <correspondent>-<account_number> in wire_instructions, where <correspondent> is your 4-character correspondent code and <account_number> is the account's 9-character account number.

currency defaults to USD and must match the account's base currency. Supported currencies are AUD, CAD, CHF, EUR, GBP, JPY, NZD, SGD, TRY, and USD.

The wire is created with status QUEUED and processed asynchronously on the next worker run.

Body Params

The amount, currency, and destination account of the simulated incoming wire.

Request body for simulating an incoming wire transfer in the sandbox environment.

currency defaults to USD when omitted and must match the base currency of the destination account. Supported currencies are AUD, CAD, CHF, EUR, GBP, JPY, NZD, SGD, TRY, and USD. Other currencies are rejected with 422.

amount

string

required

Amount of the incoming wire. Must be greater than 0.

currency

string

"USD" // US Dollar
"JPY" // Japanese Yen
"EUR" // Euro
"CAD" // Canadian Dollar
"GBP" // British Pound Sterling
"CHF" // Swiss Franc
"TRY" // Turkish Lira
"AUD" // Australian Dollar
"CZK" // Czech Koruna
"SEK" // Swedish Krona
"DKK" // Danish Krone
"SGD" // Singapore Dollar
"HKD" // Hong Kong Dollar
"HUF" // Hungarian Forint
"NZD" // New Zealand Dollar
"NOK" // Norwegian Krone
"PLN" // Poland Złoty

delay_until

date-time | null

Accepted and returned in the response, but not currently used. The wire is processed on the next worker run regardless of this value.

wire_instructions

string

required

FFC [0-9A-Za-z]{4}[-\s]?[0-9A-Za-z]{9}

Must contain an FFC (For Further Credit) string identifying the destination account, in the form FFC <correspondent>-<account_number>. The hyphen can also be a space or omitted. Text before or after the FFC string is ignored.

<correspondent> must be your 4-character correspondent code, and <account_number> must be the 9-character account number of one of your accounts. Only the first 9 characters after the correspondent code are read as the account number.

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

200The simulated incoming wire was created.

400The request body is malformed, for example invalid JSON.

403The endpoint was called in production. It is only available in the sandbox environment.

404No account with the account number in wire_instructions exists for your correspondent.

defaultUnexpected error.