GET

Merchant Functions

Get checkout data

/api/v2/merchant/checkout

AUTHENTICATIONBearer token · commerce:readService ownermerchant-commerceContract 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: list checkout data through the authoritative commerce service boundary.

When to use it

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

OUTCOME · Planned · Discover

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 checkout data without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to discover checkout data.
Connects catalog and invoice operations to payment collection and treasury reconciliation without making presentation state or a reserved address proof of payment.

ISOLATION + AUTHORITY

Tenant, workspace, merchant, product, customer, invoice, checkout, collection wallet, payment, custody, treasury settlement, tax or compliance policy, and finality remain distinct. Merchant configuration or invoice state cannot authorize wallet signing, move funds, prove settlement, or grant publisher, matching, or trading authority. 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.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.

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 checkout data 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 checkout data only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
Distinguish merchant readiness, product availability, invoice issuance, checkout presentation, payment observation, wallet synchronization, treasury settlement, cancellation, and reconciliation.
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 commerce:read authority.EXAMPLEBearer hc_live_…

cursorqueryOptional

opaque stringCursor returned by the previous page.EXAMPLEeyJvZmZzZXQiOjUwfQ

limitqueryOptional

integer · 1–200Maximum records to return.EXAMPLE50

statusqueryOptional

stringOptional lifecycle-state filter.EXAMPLEACTIVE

qqueryOptional

string · max 200Optional application search term.EXAMPLEtreasury

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations through an implemented operation.
ESCALATE WHEN: Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations through an implemented operation.
ESCALATE WHEN: Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations through an implemented operation.
ESCALATE WHEN: Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations through an implemented operation.
ESCALATE WHEN: Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations through an implemented operation.
ESCALATE WHEN: Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

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.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/merchant/checkoutMERCHANT: Get Checkout Data

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