Send a transfer with your
management key.
Read one with a management or management::read key.
Both routes spend one token from the account throttle.
Send a transfer
directionis named from the subaccount’s side:fundmoves money into it, anddefundmoves money out.amountis a positive decimal with at most 5 places. We never round it.clientTransferIdis your idempotency key, up to characters and unique per trader. Send one.
- Request
- 202
Retry a transfer
What a retry does depends on theclientTransferId you send.
Check the transfer status
GET /v3/account/subaccounts/{keyId}/transfers/{id} returns the transfer. Pass the transferId from the 202 as {id}.
Its status tells you whether the money moved.
If a transfer stays
Requested, contact support. Don’t retry it under a new ID.
On a Rejected transfer, actualBalance holds the balance we found.
Transfers and transactions
A transfer is your request to move money, and its status. It covers funding and defunding. A transaction is one row in your ledger: one movement of the balance. We write one only when money moves, for fills, fees, maker credits, settlements, and applied transfers.
Read a transfer with
GET /v3/account/subaccounts/{keyId}/transfers/{id}.
List transactions with GET /v3/account/subaccounts/{keyId}/transactions.
No route lists transfers.
If you lose a transferId, send the same request again with the same clientTransferId to recover it.
