GET

Programmable barriers

Get barrier

/api/v2/barriers/{barrier_uuid}

AUTHENTICATIONBearer token · barriers:readService ownerbarrier-serviceContract sourceCapability 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 and usage

What this endpoint does

Planned capability: return one barrier definition, observations, state transitions, and evidence.

When to use it

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

OUTCOME · Planned · Inspect

What changes

None today: this route is not executable. Its intended behavior is: read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Lets people and agents prepare for barrier without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to inspect barrier.
Makes product terms and observed trigger evidence inspectable without treating a quote, observation, or validation as issuance, activation, payoff, or settlement.

ISOLATION + AUTHORITY

Issuer, owner, product definition, underlying, price source, observation schedule, validation, activation, position, trigger, valuation, cancellation, closeout, wallet, and settlement remain distinct. No barrier record grants order, matching, publisher, custody, or trading authority, and current trading controls remain frozen. 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 barrier_uuid (path) as planning input only; re-generate the request from deployed OpenAPI before making a call.

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 barrier 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 barrier only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed barrier_uuid (path) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Distinguish draft terms, quote, validation, activation, scheduled observation, barrier event, valuation, position, cancellation, closeout, payout, and settlement.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

Contract reference

This is a planned, non-executable contract. Do not send requests or register it as an executable agent tool.

Request and response

Make the request

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 barriers:read authority.EXAMPLEBearer hc_live_…

barrier_uuidpathRequired

identifierCanonical barrier uuid.EXAMPLEbarrier-uuid-01

RESPONSES

Status and payload examples

200Canonical resource projection.Not executable · JSON RESPONSE+

{
  "result": "See the operation's authoritative OpenAPI response schema."
}

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 tenant and resource barriers, policy decisions, eligibility evidence, and fail-closed access results through an implemented operation.
ESCALATE WHEN: Escalate when a barrier decision lacks its policy version or evidence, or when resolving it would require bypassing a fail-closed control.

401Bearer credential is missing, expired, or invalid.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONrequest_failed

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 tenant and resource barriers, policy decisions, eligibility evidence, and fail-closed access results through an implemented operation.
ESCALATE WHEN: Escalate when a barrier decision lacks its policy version or evidence, or when resolving it would require bypassing a fail-closed control.

403The principal lacks the required scope, role, tenant, or step-up authority.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The principal lacks the required scope, role, tenant, or step-up authority."
}

INTEGRATION DECISIONrequest_failed

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 tenant and resource barriers, policy decisions, eligibility evidence, and fail-closed access results through an implemented operation.
ESCALATE WHEN: Escalate when a barrier decision lacks its policy version or evidence, or when resolving it would require bypassing a fail-closed control.

422Path, query, or body validation failed.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}

INTEGRATION DECISIONrequest_failed

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 tenant and resource barriers, policy decisions, eligibility evidence, and fail-closed access results through an implemented operation.
ESCALATE WHEN: Escalate when a barrier decision lacks its policy version or evidence, or when resolving it would require bypassing a fail-closed control.

503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}

INTEGRATION DECISIONrequest_failed

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 tenant and resource barriers, policy decisions, eligibility evidence, and fail-closed access results through an implemented operation.
ESCALATE WHEN: Escalate when a barrier decision lacks its policy version or evidence, or when resolving it would require bypassing a fail-closed control.

OPERATIONAL NOTES

Security and lifecycle guarantees

The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.

Reference version and availability details

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