DOCUMENTATIONv2

POST

Funding & settlement

Prepare binding

/api/v2/funding/bindings

AUTHENTICATIONBearer token · funding:writeAUTHORITATIVE OWNERfunding-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Prepare an owner-scoped wallet activation binding for one network, chain, and currency; the resulting PREPARED route cannot receive credit or activate value movement.

WHEN THIS CALL IS USEFUL

Use after an MPC wallet activation exists to prepare one owner-scoped funding route for a specific network, chain, and currency. Preparation makes the route discoverable to later funding workflows without making it value-bearing.

OUTCOME · Create or advance

What changes

Creates or returns only a PREPARED binding and route-policy commitment. It assigns no deposit coordinate, credits no balance, enables no withdrawal, and moves no value.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance prepare binding.
Connects funding observations to exact owner, instrument, wallet, rail, and settlement context without making the gateway the owner of value.

ISOLATION + AUTHORITY

Owner, workspace, network, instrument, wallet, rail, custody, collateral, compliance, and settlement authorities remain separate. A prepared route, observed deposit, accepted intent, completed consent, reservation, broadcast, or Explorer record does not itself prove final settlement or authorize value movement.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required network_id (body), activation_identifier (body) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the owner, network, instrument or wallet, rail, and settlement context before relying on this result.

WHAT TO DO NEXT

Re-read prepare binding using the canonical identifier returned by this operation.
Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
Reconcile the returned state against the authoritative wallet, rail, and settlement record before advancing or retrying.

AGENT GUIDANCE

Use prepare binding 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 (body), activation_identifier (body) exactly as defined by the live contract.
Preserve amounts and fees as exact decimal strings and distinguish observed, accepted, authorized, reserved, broadcast, confirmed, settled, reversed, and reconciled states.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

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 the funding:write scope.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated key reused for every retry of the same logical mutation.EXAMPLElaunch-treasury-v1-001

Content-TypeheaderRequired

application/jsonSigned mutations accept canonical JSON only.EXAMPLEapplication/json

Content-DigestheaderRequired

RFC 9530 SHA-256 digestDigest of the exact transmitted body bytes.EXAMPLEsha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:

Signature-InputheaderRequired

RFC 9421 signature parametersCovers @method, @path, content-digest, content-type, and idempotency-key; includes keyid, nonce, created, and expires.EXAMPLEsig1=("@method" "@path" "content-digest" "content-type" "idempotency-key");created=1786582800;expires=1786583100;nonce="01J…";keyid="machine-prod"

SignatureheaderRequired

Ed25519 HTTP Message SignatureSignature made by an active public key registered to the authenticated client.EXAMPLEsig1=:base64-signature:

network_idbodyRequired

hybrid-devnet | hybrid-testnet | hybrid-mainnetMust equal the authenticated network and the selected activation.EXAMPLEhybrid-testnet

activation_identifierbodyRequired

identifierOwner-scoped active MPC wallet activation; wallet UUID and native address are derived, never accepted.EXAMPLEactivation-01

chain_codebodyOptional

uppercase chain code · default HYBRIDDeposit rail. HYBRID selects the canonical native-asset boundary.EXAMPLEHYBRID

currencybodyOptional

uppercase asset code · max 16For HYBRID, omission selects the network's configured native asset.EXAMPLETHYB

REQUEST

JSON body example

{
  "network_id": "hybrid-testnet",
  "activation_identifier": "activation-01",
  "chain_code": "HYBRID",
  "currency": "THYB"
}

RESPONSES

Status and payload examples

201PREPARED route policy recorded; no value capability is active.Mutation completed · JSON RESPONSE+

{
  "binding_uuid": "binding-01",
  "network_id": "hybrid-testnet",
  "chain_code": "HYBRID",
  "currency": "THYB",
  "state": "PREPARED",
  "route_policy_commitment": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "value_bearing_enabled": false,
  "next_required_action": "ASSIGN_AND_ATTEST_DEPOSIT_ROUTE"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read prepare binding using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.

200Equivalent existing binding returned idempotently.Mutation completed · JSON RESPONSE+

{
  "binding_uuid": "binding-01",
  "state": "PREPARED",
  "created": false,
  "idempotent": true,
  "value_bearing_enabled": false
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read prepare binding using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.

400The network, activation, chain, currency, signed headers, or idempotency key is malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_funding_binding",
  "message": "The network, activation, chain, currency, signed headers, or idempotency key is malformed."
}

INTEGRATION DECISIONinvalid_funding_binding

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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

401The bearer credential is invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

403The principal lacks funding:write or does not own the activation.Authority or policy denied · JSON RESPONSE+

{
  "code": "funding_binding_forbidden",
  "message": "The principal lacks funding:write or does not own the activation."
}

INTEGRATION DECISIONfunding_binding_forbidden

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for owner-scoped funding methods, deposit instructions, transfer intents, settlement progress, and delivery receipts.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

404The active owner-scoped wallet activation was not found.Resource not visible · JSON RESPONSE+

{
  "code": "activation_not_found",
  "message": "The active owner-scoped wallet activation was not found."
}

INTEGRATION DECISIONactivation_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

409Network, native-asset, activation, or existing-route policy conflicts.State reconciliation required · JSON RESPONSE+

{
  "code": "funding_binding_conflict",
  "message": "Network, native-asset, activation, or existing-route policy conflicts."
}

INTEGRATION DECISIONfunding_binding_conflict

CALLER ACTION: Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY: Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

422The network does not support the selected chain or currency.Request must change · JSON RESPONSE+

{
  "code": "unsupported_funding_route",
  "message": "The network does not support the selected chain or currency."
}

INTEGRATION DECISIONunsupported_funding_route

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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

503The wallet activation, Funding owner, or evidence ledger is unavailable; no route is prepared.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "funding_binding_unavailable",
  "message": "The wallet activation, Funding owner, or evidence ledger is unavailable; no route is prepared."
}

INTEGRATION DECISIONfunding_binding_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.
ESCALATE WHEN: Escalate when money movement is ambiguous, provider and ledger states disagree, or a destination or asset cannot be proven exact.

OPERATIONAL NOTES

Security and lifecycle guarantees

This reviewed planning contract is non-executable until present in production OpenAPI.
The bearer determines the owner. Never send profile, vault, wallet, or address selectors, private keys, seeds, MPC shares, or signing nonces.
PREPARED is not ACTIVE: it assigns no deposit coordinate, credits no balance, enables no withdrawal, and moves no value.
The unique logical binding is owner + activation + network + chain + currency; reuse an Idempotency-Key only for the byte-equivalent request.

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 ↗