Approve an adjustment
Adds one approval to a pending adjustment (risk:approve, a person); the maker cannot (403 SELF_APPROVAL), nor can anyone twice (409 ALREADY_APPROVED). The approval that meets the organisation’s risk count applies it. Takes no If-Match. Answers the adjustment.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
The adjustment’s id — a positive 64-bit integer as decimal digits.
Headers
Required on every write: a URL-safe string of 1 to 64 characters from [A-Za-z0-9._~-] (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (Idempotent-Replay: true) or attaches to the live one, and reuse on another record refuses 409 IDEMPOTENCY_KEY_REUSED. Missing or malformed, 400.
Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.
Query parameters
A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.
Request
Response
The adjustment as the platform now holds it after the write — the same row the read serves, with the answering change’s position, its ETag and, on a replayed key, Idempotent-Replay.
The adjustment’s id, a 64-bit integer as decimal digits.
The adjustment’s version as a decimal string: 1 when proposed, one more for each approval and for the withdrawal; its ETag.
The account adjusted (GET /accounts).
The derivative position’s instrument (GET /positions); null when the adjustment is of an inventory.
The inventory’s asset (GET /risk/exposures); null when the adjustment is of a position.
PENDING_APPROVAL: proposed, moving nothing until approved. APPLIED: in the position or the inventory, as of effectiveSeq. WITHDRAWN: withdrawn, never applied. The value set is append-only: read an unknown value as UNKNOWN.
Why it was made. The value set is append-only: read an unknown value as UNKNOWN.
How the cost arm applies to the position’s cost basis in its settle asset, or the inventory’s cost basis in USD: SET replaces it, DELTA adds to it, NONE leaves it.
money (an exact decimal string at the scale the proposal stated it): the cost arm’s value; null when its mode is NONE.
How the realizedPnl arm applies to the position’s realized PnL in its settle asset, or the inventory’s realized PnL in USD: SET replaces it, DELTA adds to it, NONE leaves it.
money (an exact decimal string at the scale the proposal stated it): the realizedPnl arm’s value; null when its mode is NONE.
The asset the fee arm is in; null when the fee is not adjusted.
How the fee arm applies to a position’s fees paid in feeAssetId: SET, DELTA or NONE.
money (an exact decimal string at the scale the proposal stated it): the fee arm’s value; null when its mode is NONE.
How the funding arm applies to the position’s cumulative funding in its settle asset: SET replaces it, DELTA adds to it, NONE leaves it.
money (an exact decimal string at the scale the proposal stated it): the funding arm’s value, in the position’s settle asset; null when its mode is NONE.
The stream position the adjustment takes effect at — its proposal’s: an applied adjustment moves the position or the inventory as it stood then, and every fill since is replayed through it.
The maker — an actor, always a member’s: only members write risk.
Who approved it and when, in approval order; empty until the first approval. It applies when they number the organisation’s risk rule in force at that approval, and at least one (GET /approval-rules?family=RISK).
When it was applied, epoch nanoseconds; null until then.
Who withdrew it; null unless withdrawn.
Who produced this state: the maker on the proposal, an approver on an approval, the withdrawer on the withdrawal.
Why it was withdrawn; empty unless withdrawn.
The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.