Developer Portal
Admin APIsAccounts & FundingFunding

Deposit FundsPOST

Create a deposit transaction that credits funds to the specified trading account. Requires the 'funding:deposit' permission; callers without it receive 403 AUTH_NO_PERMISSION (onboarding-only tokens do not include funding access).

View as Markdown
POST
/accounts/{accountId}/deposit

Authorization

Authorization<token>

Bearer access token issued by the admin login flow.

In: header

Request Body

application/jsonRequired
commentOptional, The comment for the deposit
amountnumber

The amount to deposit/withdraw, in account currency. Sent/received as a JSON string (e.g. "10000"), per proto3 JSON encoding of doubles.

Format: "double"
clientDealIdstring

Optional passthrough audit metadata (max 36 chars); not used for deduplication.

Path Parameters

accountIdRequiredstring

The account id to deposit to

curl -X POST "https://example.com/accounts/<string>/deposit" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "string",
    "amount": 0.1,
    "clientDealId": "string"
  }'

A successful response.

{
  "dealId": "string"
}

Deal History

Return historical balance and trading deals for the specified account within the requested date range.

Withdraw Funds

Create a withdrawal transaction that debits funds from the specified trading account. Requires the 'funding:withdraw' permission; callers without it receive 403 AUTH_NO_PERMISSION (onboarding-only tokens do not include funding access).