Transfers facilitate the movement of assets between accounts, enabling transactions such as payments and withdrawals.
Endpoints:
- GET List Transfers: GET /transfers
- POST Initiate a Transfer: POST /transfers
- GET Get a single Transfer: GET /transfers/{uid}
- PUT Cancel a Transfer: PUT /transfers/{uid}/cancel
A Transfer is the Action of moving assets between two Synthetic Accounts. Most asset movement initiated by your application will result in a Transfer. Asset movement is determined by the makeup of assets in both participating accounts, the Synthetic Account Type of the participating accounts, the available Custodial Accounts for all participating Customers, and the overall Program configuration. A Transfer can never be initiated between two external accounts.
Note Any time a Transfer is created, it creates 1+ Transactions, which are returned in the response payload for a successful Transfer. Please note or record these uids, as they will be needed to query the Transaction object and any associated key data points. For instance, Fed IMAD or CHIPS SSN is used for outgoing wires.