DOCUMENTATIONv2

POST

Funding & settlement

Create settlement intent

/api/v2/funding/settlement-intents

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

PURPOSE + BUSINESS CONTEXT

Create an owner-scoped withdrawal or internal-transfer intent in AUTHORIZATION_REQUIRED state; creation neither reserves collateral nor signs, broadcasts, or moves funds.

WHEN THIS CALL IS USEFUL

Use to record an exact withdrawal or same-network internal-transfer proposal before customer consent and every custody, collateral, and finality gate.

OUTCOME · Create or advance

What changes

Records AUTHORIZATION_REQUIRED state and commitments only; it does not reserve collateral, collect consent, produce an MPC signature, broadcast a transaction, credit a recipient, or move funds.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance settlement intent.
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), intent_type (body), activation_identifier (body), amount (body), currency (body), destination_reference (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 settlement intent 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 settlement intent 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), intent_type (body), activation_identifier (body), amount (body), currency (body), destination_reference (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-mainnetNetwork shared by source activation and destination.EXAMPLEhybrid-testnet

intent_typebodyRequired

WITHDRAWAL | INTERNAL_TRANSFERINTERNAL_TRANSFER resolves an active same-network Hybrid wallet; WITHDRAWAL targets an eligible external destination.EXAMPLEINTERNAL_TRANSFER

activation_identifierbodyRequired

identifierOwner-scoped active MPC wallet activation used to derive the source.EXAMPLEactivation-01

amountbodyRequired

non-negative exact decimal string · max 18 fractional digitsNever send a JSON floating-point number. Production non-zero value remains fail closed.EXAMPLE0

chain_codebodyOptional

uppercase chain code · default HYBRIDINTERNAL_TRANSFER requires HYBRID.EXAMPLEHYBRID

currencybodyRequired

uppercase asset code · max 16Exact settlement asset for the network and rail.EXAMPLETHYB

destination_referencebodyRequired

network-valid destination identifierExternal-rail destination or same-network native destination, interpreted by intent_type.EXAMPLEthyb1destination…

sender_sequencebodyOptional

integer · ≥1Latest source-wallet sequence. Stale values fail with HTTP 409; omission lets Core lock its current sequence.EXAMPLE12

REQUEST

JSON body example

{
  "network_id": "hybrid-testnet",
  "intent_type": "INTERNAL_TRANSFER",
  "activation_identifier": "activation-01",
  "amount": "0",
  "chain_code": "HYBRID",
  "currency": "THYB",
  "destination_reference": "thyb1destination…",
  "sender_sequence": 12
}

RESPONSES

Status and payload examples

201Exact intent recorded in AUTHORIZATION_REQUIRED state; funds remain unmoved.Mutation completed · JSON RESPONSE+

{
  "intent_uuid": "intent-01",
  "state": "AUTHORIZATION_REQUIRED",
  "request_commitment": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
  "policy_commitment": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
  "sender_sequence": 12,
  "value_bearing_enabled": false,
  "next_required_action": "EXACT_CUSTOMER_CONSENT",
  "funds_moved": false
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read settlement intent 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.

200Byte-equivalent idempotent replay returned.Mutation completed · JSON RESPONSE+

{
  "intent_uuid": "intent-01",
  "state": "AUTHORIZATION_REQUIRED",
  "idempotency_replayed": true,
  "funds_moved": false
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read settlement intent 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.

400An intent field, signed header, or idempotency key is malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_settlement_intent",
  "message": "An intent field, signed header, or idempotency key is malformed."
}

INTEGRATION DECISIONinvalid_settlement_intent

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 source activation.Authority or policy denied · JSON RESPONSE+

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

INTEGRATION DECISIONsettlement_intent_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 source activation or same-network destination was not found.Resource not visible · JSON RESPONSE+

{
  "code": "settlement_endpoint_not_found",
  "message": "The source activation or same-network destination was not found."
}

INTEGRATION DECISIONsettlement_endpoint_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.

409Sequence changed, destination is ineligible, production value remains disabled, or the idempotency key conflicts.State reconciliation required · JSON RESPONSE+

{
  "code": "settlement_intent_conflict",
  "message": "Sequence changed, destination is ineligible, production value remains disabled, or the idempotency key conflicts."
}

INTEGRATION DECISIONsettlement_intent_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.

422Network, native-asset, exact-decimal, destination, or policy validation failed.Request must change · JSON RESPONSE+

{
  "code": "settlement_policy_rejected",
  "message": "Network, native-asset, exact-decimal, destination, or policy validation failed."
}

INTEGRATION DECISIONsettlement_policy_rejected

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.

503Funding, wallet, collateral, or evidence ownership is unavailable; no intent is created.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "settlement_intent_unavailable",
  "message": "Funding, wallet, collateral, or evidence ownership is unavailable; no intent is created."
}

INTEGRATION DECISIONsettlement_intent_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.
Creation records a proposal only. It does not reserve collateral, collect consent, create an MPC signature, broadcast, credit a recipient, or move funds.
INTERNAL_TRANSFER requires HYBRID and an active destination in the same network. Never infer eligibility from an address format alone.
The later lifecycle is exact consent → authorization → collateral reservation → MPC signing → broadcast → validator finality; observe every stage separately.

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 ↗