Simulate an Incoming Wire Transfer

Simulate an inbound wire transfer arriving at a customer account.

This endpoint is only available in the Sandbox environment and exists so you can fund an account end-to-end without involving a real counterparty bank. In production, incoming wires originate at the sending bank and cannot be created via the API.

The wire_instructions field must follow the FFC (For Further Credit) format FFC <correspondent>-<account_number>, where <correspondent> is your 4-character correspondent code and <account_number> is the customer's brokerage account number.

Body Params

Request body for simulating an incoming wire in Sandbox.

string
required

Must be > 0.00

string
required

"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

date-time | null

Optional timestamp before which the wire will not be processed.

string
required

FFC (For Further Credit) string identifying the destination account, in the form FFC <correspondent>-<account_number>.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json