DOCUMENTATIONv2

POST

Digital assets

Cancel listing

/api/v2/asset-listings/{listing_uuid}/cancellations

AUTHENTICATIONBearer token · assets:listAUTHORITATIVE OWNERasset-registry-serviceCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: cancel an active listing and preserve an immutable lifecycle record.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future listing workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Create or advance

What changes

None today: this route is not executable. Its intended behavior is: no executable public mutation exists. A future success would mark the listing CANCELLED, release only eligible unconsumed reservations, and append cancellation evidence; it would not cancel paid orders, reverse delivery, refund payment, or alter asset supply.

WHY IT MATTERS

Lets people and agents prepare for listing without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance listing.
Lets clients verify asset identity and provenance without treating display metadata or portfolio visibility as issuance or trading authority.

ISOLATION + AUTHORITY

Issuer, collection, asset, mint, proof, owner, network, supply, metadata, custody, marketplace, and trading boundaries remain distinct. Reading an asset or proof cannot issue, mint, transfer, list, value, or trade it; current trading and matching controls remain frozen unless separately approved. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Authenticate at the documented boundary: bearer+scope.
Treat the proposed listing_uuid (path), expected_listing_version (body), expected_status (body), reason_code (body), step_up_token (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the canonical asset or collection identifier, issuer, network, lifecycle, supply, and required proof freshness.

WHAT TO DO NEXT

Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
Use the stated owner, lifecycle, authority boundary, and provisional listing profile to prepare requirements and conformance tests without sending a request.
Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Use listing only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed listing_uuid (path), expected_listing_version (body), expected_status (body), reason_code (body), step_up_token (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Distinguish declared metadata, issuer identity, collection membership, mint evidence, supply state, ownership or custody, market listing, price, transfer, and finality.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the assets:list 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:

listing_uuidpathRequired

seller-scoped listing identifierExact listing whose current terms and reservations are reconciled before cancellation.EXAMPLElisting-01

expected_listing_versionbodyRequired

integer · ≥1Current listing version; prevents cancellation of replaced terms.EXAMPLE4

expected_statusbodyRequired

ACTIVE | PAUSEDLast-read eligible listing state.EXAMPLEACTIVE

reason_codebodyRequired

SELLER_CANCELLED | TERMS_CHANGED | INVENTORY_UNAVAILABLE | COMPLIANCE_HOLDStructured reason retained with lifecycle evidence.EXAMPLESELLER_CANCELLED

reason_detailbodyOptional

string · 8–500Optional safe explanation without credentials, customer evidence, or regulated identity data.EXAMPLESeller withdrew the current terms.

step_up_tokenbodyRequired

purpose-bound tokenFresh ASSET_LISTING_CANCELLATION authorization bound to version and reason.EXAMPLEhcsu_…

REQUEST

JSON body example

{
  "expected_listing_version": 4,
  "expected_status": "ACTIVE",
  "reason_code": "SELLER_CANCELLED",
  "reason_detail": "Seller withdrew the current terms.",
  "step_up_token": "hcsu_…"
}

RESPONSES

Status and payload examples

200Eligible listing cancelled and unconsumed reservations released.Not executable · JSON RESPONSE+

{
  "listing_uuid": "listing-01",
  "status": "CANCELLED",
  "version": 5,
  "released_quantity": "7.00000000",
  "protected_order_count": 1,
  "cancellation_commitment": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

INTEGRATION DECISION

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

400A field, signed header, step-up token, or idempotency key is malformed.Not executable · JSON RESPONSE+

{
  "code": "invalid_listing_cancellation",
  "message": "A field, signed header, step-up token, or idempotency key is malformed."
}

INTEGRATION DECISIONinvalid_listing_cancellation

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

401The bearer credential is invalid.Not executable · JSON RESPONSE+

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

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

403The principal lacks assets:list, seller or compliance authority, or fresh step-up.Not executable · JSON RESPONSE+

{
  "code": "listing_cancellation_forbidden",
  "message": "The principal lacks assets:list, seller or compliance authority, or fresh step-up."
}

INTEGRATION DECISIONlisting_cancellation_forbidden

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

404The listing is not visible in this seller and network boundary.Not executable · JSON RESPONSE+

{
  "code": "listing_not_found",
  "message": "The listing is not visible in this seller and network boundary."
}

INTEGRATION DECISIONlisting_not_found

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

409Version or state is stale, an order consumed inventory, cancellation is terminal, or idempotency conflicts.Not executable · JSON RESPONSE+

{
  "code": "listing_cancellation_conflict",
  "message": "Version or state is stale, an order consumed inventory, cancellation is terminal, or idempotency conflicts."
}

INTEGRATION DECISIONlisting_cancellation_conflict

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

422Reason, reservation, active-order, compliance, evidence, or lifecycle policy rejected cancellation.Not executable · JSON RESPONSE+

{
  "code": "listing_cancellation_rejected",
  "message": "Reason, reservation, active-order, compliance, evidence, or lifecycle policy rejected cancellation."
}

INTEGRATION DECISIONlisting_cancellation_rejected

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

503Listing, holdings, orders, or evidence ownership is unavailable; state is unchanged.Not executable · JSON RESPONSE+

{
  "code": "listing_cancellation_unavailable",
  "message": "Listing, holdings, orders, or evidence ownership is unavailable; state is unchanged."
}

INTEGRATION DECISIONlisting_cancellation_unavailable

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN: Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

OPERATIONAL NOTES

Security and lifecycle guarantees

Reviewed planning contract: do not call until the exact operation appears in live production OpenAPI.
The bearer identifies the seller; seller, owner, workspace, vault, wallet, and database selectors are never accepted.
Cancellation releases only eligible unconsumed reservations. It cannot cancel or refund a paid order, reverse delivery, change supply, settle value, or authorize trading.
After an ambiguous response, re-read the listing, reservations, and affected orders before reusing the same Idempotency-Key and body.

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗