DOCUMENTATIONv2

GET

Funding & settlement

List deposits

/api/v2/funding/deposits

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

PURPOSE + BUSINESS CONTEXT

List the authenticated owner's newest observed deposits, confirmation progress, reserve commitments, exact decimal amounts, retained first-observed valuation, and credit-availability lifecycle without exposing owner IDs, wallet IDs, or native addresses.

WHEN THIS CALL IS USEFUL

Use after funding coordinates are configured to reconcile the authenticated owner's observed chain deposits, confirmation progress, reserve evidence, and credit-availability posture without exposing wallet addresses or widening the owner boundary.

OUTCOME · Discover

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 discover deposits.
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.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the owner, network, instrument or wallet, rail, and settlement context before relying on this result.

WHAT TO DO NEXT

Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
Reconcile the returned state against the authoritative wallet, rail, and settlement record before advancing or retrying.

AGENT GUIDANCE

Use deposits only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Preserve amounts and fees as exact decimal strings and distinguish observed, accepted, authorized, reserved, broadcast, confirmed, settled, reversed, and reconciled 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 the funding:read scope.EXAMPLEBearer hc_live_…

cursorqueryOptional

opaque 32-character hexadecimal cursornext_cursor returned by the preceding owner-scoped page; reuse only with the same state filter.EXAMPLEbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

limitqueryOptional

integer · 1–200 · default 50Maximum newest records returned.EXAMPLE50

statequeryOptional

RESPONSES

Status and payload examples

200Newest owner-scoped deposits with confirmation progress, reserve evidence, exact amounts, and retained first-observed valuation.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "deposit_id": "4f5d2c7a1be747f99d62a8c87345fce2",
      "binding_id": "d9014c2174164a6cb86c74b4c0fd23e1",
      "network_id": "bitcoin-mainnet",
      "chain_code": "BTC",
      "currency": "BTC",
      "transaction_hash": "9e8f…",
      "output_index": 0,
      "block_hash": "000000…",
      "block_height": 900000,
      "amount": "0.12500000",
      "confirmations_observed": 8,
      "confirmations_required": 6,
      "state": "AVAILABLE",
      "observer_certificate_commitment": "sha256:…",
      "collateral_entry_id": "a822…",
      "detected_at": "2026-08-31T12:00:00Z",
      "reserve_attested_at": "2026-08-31T12:05:00Z",
      "available_at": "2026-08-31T12:06:00Z",
      "updated_at": "2026-08-31T12:06:00Z",
      "first_observed_valuation": {
        "price_usd": "109500.12",
        "value_usd": "13687.5150000000",
        "price_evidence_id": "7ce2…",
        "observed_at": "2026-08-31T12:00:00Z",
        "source": "SIGNED_PRICE_EVIDENCE"
      }
    }
  ],
  "next_cursor": null,
  "limit": 50
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
RETRY SAFETY: For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the funding method and transfer or deposit lifecycle; compare amount, asset, network, destination, provider reference, and terminal settlement evidence.

400A query field is malformed or unknown.Request must change · JSON RESPONSE+

{
  "code": "invalid_query",
  "message": "A query field is malformed or unknown."
}

INTEGRATION DECISIONinvalid_query

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 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 missing, invalid, or expired.Authentication required · JSON RESPONSE+

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

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. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned 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.

403The bearer lacks exact funding:read authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The bearer lacks exact funding:read authority."
}

INTEGRATION DECISIONinsufficient_scope

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.

422The cursor, limit, or exact lifecycle state is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_funding_query",
  "message": "The cursor, limit, or exact lifecycle state is invalid."
}

INTEGRATION DECISIONinvalid_funding_query

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 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 authoritative owner-scoped funding projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "funding_unavailable",
  "message": "The authoritative owner-scoped funding projection is unavailable."
}

INTEGRATION DECISIONfunding_unavailable

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 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

Use after funding coordinates are configured to reconcile observed deposits and their progress toward the Core funding lifecycle. Records are newest first and responses are no-store.
amount, price_usd, and value_usd are exact decimal strings. first_observed_valuation is historical evidence captured when first observed, not a current market quote.
AVAILABLE does not independently authorize withdrawal, transfer, settlement, trading, credit release, or operational control. Re-fetch after new confirmations or a possible reorganization.
The bearer derives profile and workspace boundaries. Owner IDs, vault IDs, wallet IDs, native addresses, private bank data, and signing material are excluded; callers cannot add selectors that widen the owner scope.

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 ↗