Transfers
Transfer APIs move funds between any two accounts of the same customer or across customers. You cannot transfer funds across clients using the Transfers API. To transfer funds across clients, use the Withdrawals functionality. To transfer funds across currencies, use the Exchanges functionality.
There are 3 steps to performing a transfer:
-
Setup the Transfer - Setup the transfer using the
transfers
endpoint . This will give you thetransfer_id
that you will need to accept/execute or retrieve details on the transfer. -
Execute the Transfer - Accept the transfer using the
transfers/{transfer_id}/accept
endpoint . Thestatus
field in the response will provide the status of the transfer. -
Retrieve Transfer Details - You can get details of any executed Transfer using the
transfers/{transfer_id}
endpoint