DOCUMENTATIONv2

GET

Merchant commerce

List merchant profiles

/api/v2/commerce/merchants

AUTHENTICATIONBearer token · commerce:readAUTHORITATIVE OWNERcommerce-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List merchant profiles available to the active workspace.

WHEN THIS CALL IS USEFUL

Discover owner-visible merchants and their review posture before selecting a merchant for catalog, invoice, wallet-observation, or settlement planning.

OUTCOME · Discover

What changes

Read-only owner-scoped projection of merchant profiles; it cannot activate a merchant, publish a product, create checkout, assert payment, settle a wallet, fulfill an order, move value, or grant authority.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover merchant profiles.
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.

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.

WHAT TO DO NEXT

Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
Open the canonical merchant, invoice, payment, or rotational-wallet record for the next stage and verify settlement independently before marking the commercial obligation complete.

AGENT GUIDANCE

Use merchant profiles 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.
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.

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

cursorqueryOptional

32-character hexadecimal cursor · nullableCursor returned by the preceding page; reuse only with identical filters.EXAMPLEeyJvZmZzZXQiOjUwfQ

limitqueryOptional

integer · 1–200 · nullableMaximum records to return; defaults to 50 and cannot exceed 200.Schema range: 0 to unboundedEXAMPLE50

statusqueryOptional

PENDING_REVIEW | ACTIVE | SUSPENDED | REJECTED | ARCHIVED · nullableExact resource lifecycle filter. Omit it to use the documented default or unfiltered behavior.EXAMPLEACTIVE

merchant_uuidqueryOptional

string · nullableMerchant owner required by product, invoice, and rotational-wallet collections.

qqueryOptional

string · 1–200 · nullableMerchant/catalog text search; unavailable for invoice and wallet collections.EXAMPLEtreasury

external_order_referencequeryOptional

string · nullableExact merchant order reference for invoice reconciliation.

network_idqueryOptional

string · nullableExplicit Hybrid network boundary required for operational and rotational wallets.

wallet_typequeryOptional

string · nullableOptional operational-wallet purpose boundary. Omit it to use the documented default or unfiltered behavior.

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

RESPONSES

Status and payload examples

200When promoted, the authenticated workspace receives the owner-scoped Commerce projection and page metadata under no-store; read state grants no checkout, payment, settlement, fulfillment, or authority transition.Read completed · JSON RESPONSE+

{}

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. Re-read the merchant or product version, invoice and linked payment-request state, and the exact network-scoped wallet projection before retrying with the same idempotency key and byte-equivalent request. Invoice state alone is not payment, settlement, or fulfillment finality.

401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid 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. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations.
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 commerce:read or access to the selected merchant boundary.Authority or policy denied · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

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 workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations.
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.

503Commerce, catalog, invoice, checkout, wallet observation, or evidence ownership is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}

INTEGRATION DECISIONinvalid_credentials

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: Re-read the merchant or product version, invoice and linked payment-request state, and the exact network-scoped wallet projection before retrying with the same idempotency key and byte-equivalent request. Invoice state alone is not payment, settlement, or fulfillment finality.
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

List merchant profiles available to the active workspace. Authoritative owner: commerce-service.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

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 ↗