Skip to main content
POST
cURL

Authorizations

X-Monaco-Signature
string
header
required

Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.

Body

application/json
asset
string | null
amount
string | null
tradingPairId
string<uuid> | null

Trading pair UUID whose isolated risk bucket receives collateral. Required for isolated risk buckets; omitted for cross risk buckets.

strategyKey
string | null

Sub-account key of the margin account whose risk bucket this names, like marginAccountId (default is the default margin account). Refused when it is not a valid sub-account key, names none of the caller's open sub-accounts, or disagrees with marginAccountId.

marginMode
string | null

Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS. A CROSS transfer names no pairs: the cross bucket's scope is the markets where it has an open position, so funding the bucket has nothing to declare.

selectedTradingPairIds
string<uuid>[] | null
deprecated

Deprecated: accepted and ignored. Cross scope is the markets where the cross bucket has an open position, so a cross transfer-in has nothing to declare and can no longer replace the scope. Rejected for ISOLATED, as before. Read the current scope from the cross bucket's row in the margin-accounts list or from this response's selectedTradingPairIds; the parent row carries no scope.

Minimum string length: 1
applyToPositionMargin
boolean | null

What the transferred collateral becomes when the ISOLATED bucket holds an open position. The two intents want opposite fates for the same dollars, so the caller states theirs:

  • true (and UNSET — the default is the human "Adjust Margin" gesture): the amount is COMMITTED to the position's stored margin. Effective leverage drops and stays down, initial margin required rises by the amount, free collateral is unchanged — new orders cannot spend it.
  • false: plain allocation. Free collateral rises and the next order can spend it. Programmatic funding loops that top a bucket up to a free collateral target MUST pass false, or each top-up converts into requirement and the loop never converges.

Either way the liquidation cushion improves identically (the breach check is bucket-equity based). On a FLAT isolated bucket there is no position to commit to and both values are a plain allocation. Explicit true is rejected for CROSS buckets (cross has no per-position margin); unset/false is a plain allocation there.

The response reports what actually happened in position_margin_credited — a credit can degrade to a plain allocation when the persisted position row is stale (close/reopen race).

marginAccountId
string | null

The margin account whose risk bucket is funded: the default margin account (the default) or any of the caller's open sub-accounts, which fund their own risk buckets from their own collateral. A copy-trading sub-account's buckets belong to its follow and are refused.

idempotencyKey
string | null

Optional submission identity, shared with order create (same 1-64 characters from [A-Za-z0-9._:-], same per user and application namespace). Retrying the same key and request within 15 minutes of the original acceptance returns the original transfer result, including its movementId, without moving money again; balance figures in a replayed response are as of the retry. The same key with a different request, or a key already used on another endpoint, returns IDEMPOTENCY_KEY_CONFLICT (HTTP 409 / gRPC ALREADY_EXISTS). ORDER_SUBMISSION_UNAVAILABLE and ORDER_SUBMISSION_CAPACITY_EXCEEDED (HTTP 503 / gRPC UNAVAILABLE) mean the outcome is held but cannot be read, or no new key can be accepted: retry with the same key and request. The window does not extend on retries; after it the key moves money again. Generate a fresh key for each intended transfer and keep it across retries of that transfer.

Response

OK

movementId
string | null
marginAccountId
string | null
asset
string | null
amount
string | null
status
string | null
newEquity
string | null
newTotalCollateralValue
string | null
newWithdrawableCollateral
string | null

The largest amount a further transfer-out will accept after this one. See MarginAccountSummary.withdrawable_collateral: this is an allocation-bounded figure, not clamped equity headroom. Truncated toward zero at the collateral asset's precision.

strategyKey
string | null

The request's strategyKey (the sub-account key), echoed; a risk-bucket transfer-in that sent none reports default.

riskBucketId
string | null

Present when collateral was allocated to a risk bucket.

marginMode
string | null

Present when collateral was allocated to a risk bucket. Values: ISOLATED, CROSS.

selectedTradingPairIds
string<uuid>[] | null

The cross bucket's scope: the markets where it has an open position, sorted by trading pair id. Only on cross risk-bucket transfers, and omitted while empty — i.e. while the bucket has no open position.

Minimum string length: 1
positionMarginCredited
boolean | null

Whether the transfer was committed to a position's stored margin. Present only when a position-margin credit was in play: true — the credit landed; false — a credit was requested (or defaulted) but degraded to a plain allocation because the bucket's persisted position row was stale (close/reopen race) — re-issue the Adjust Margin once the new position row lands if the commitment still matters. Absent on plain allocations, parent deposits, and releases.