Transfer cash

Note

Moves cash for your clients. A single endpoint covers three cases, chosen by which side you fill in:

  • Deposit — provide only toBrokerClientId to add cash to a client's account.
  • Withdrawal — provide only fromBrokerClientId to take cash out.
  • Account-to-account — provide both to move cash from one of your clients to another.

Deposits must be prefunded. A deposit draws on funds held for you in the house account — but this is not open credit. You need to arrange it with us in advance and prefund your account first; you can only deposit up to the amount you have prefunded. A deposit beyond your available balance is rejected with 601002 CREDIT_INSUFFICIENT. Please talk to your CONNEX contact before you start funding clients.

Amounts are strings with up to 2 decimals; USD and USDT are supported (USDT is converted to USD at the configured rate, with no fee).

The transfer is accepted synchronously and settles a moment later, so the response comes back as PENDING — poll Query transfer for the final COMPLETED / FAILED result. Always send your own clientOrderId: the operation is idempotent per that id, so retrying after a network error never moves funds twice.

Body Params
string

Source account. Leave empty for a deposit (source = CONNEX House, uses credit); set it for a withdrawal or an account-to-account transfer.

string

Source account type. Optional; defaults to cash.

string

Destination account. Leave empty for a withdrawal (destination = CONNEX House); set it for a deposit or an account-to-account transfer.

string

Destination account type. Optional; defaults to cash.

string

Currency: USD or USDT. Default USD.

string
required

Amount to transfer (max 2 decimals).

string

Your own order id, for idempotency and reconciliation. Reuse it on retries.

Headers
string

Optional client-supplied trace id, echoed through our logs for easier support. Generated for you if omitted.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json