DOCUMENTATIONv2

GET

Operational MPC wallets

Get allocation summary

/api/v2/operational-wallets/summary

AUTHENTICATIONBearer token · operational-wallets:readAUTHORITATIVE OWNERcore-operational-walletsCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Return primary, AI, merchant, deployed operational, and pending-settlement allocation for the authenticated workspace and network.

WHEN THIS CALL IS USEFUL

Call this when a wallet, treasury, custody, or governed agent workflow needs to evaluate the current status, readiness, policy, or aggregate posture of allocation summary so it can make a custody decision inside the correct owner, workspace, network, and policy boundary.

OUTCOME · Evaluate readiness

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to evaluate allocation summary.
Makes custody state understandable without exposing seeds, shares, nonces, private keys, or other reusable signing material.

ISOLATION + AUTHORITY

The authenticated owner, workspace, network, and wallet policy remain authoritative. A wallet record, policy result, approval, ceremony, or balance never grants another lifecycle stage and cannot substitute for threshold signing or separately owned funding, settlement, publisher, matching, or trading authority.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required network_id (query) exactly as defined by the live contract.
Resolve the active workspace, network, wallet lifecycle, and applicable custody policy before relying on this result.

WHAT TO DO NEXT

Re-read the wallet and policy state before the next governed action, especially after an ambiguous or concurrent result.
Refresh allocation summary when its observation time, version, or lifecycle state is no longer adequate for the decision.

AGENT GUIDANCE

Use allocation summary only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required network_id (query) exactly as defined by the live contract.
Keep enrollment, activation, policy evaluation, approval, ceremony, signing, submission, confirmation, and settlement as distinct states.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing operational-wallets:read authority.EXAMPLEBearer hc_live_…

network_idqueryRequired

hybrid-devnet | hybrid-testnet | hybrid-mainnetRequired: hybrid-devnet, hybrid-testnet, or hybrid-mainnetEXAMPLEhybrid-testnet

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

RESPONSES

Status and payload examples

200Primary, AI, merchant, deployed, and pending-settlement allocation for one network.Read completed · JSON RESPONSE+

{}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read the wallet and policy state before the next governed action, especially after an ambiguous or concurrent result.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

400The request or required headers are malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

503The authoritative service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

Return primary, AI, merchant, deployed operational, and pending-settlement allocation for the authenticated workspace and network. Authoritative owner: core-operational-wallets.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
Workspace and network context are derived from the authenticated principal and signed network assertion; callers cannot widen either boundary.
Each AI or merchant operational wallet has an independent MPC enrollment. The primary treasury cannot be assigned to an agent or merchant rotation.
Settlement is allowed only from an operational wallet to the immutable primary treasury in the same workspace and network.
Private key material, MPC shares, seeds, signing nonces, and participant secrets are never accepted or returned.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗