Skip to main content
GET
Check a merchant

Authorizations

x-api-key
string
header
required

Your platform key for buyer management, or a buyer key for everything else.

Query Parameters

domain
string
required

Merchant to check: a bare domain or an https origin with an optional root slash

Example:

"shop.example"

Response

Transaction compatibility result.

merchant
object
required

The merchant that was checked

status
enum<string>
required

supported: structured checkout is available. Anything else: use browser checkout

Available options:
supported,
unsupported,
unknown
reason
enum<string>
required

Why the merchant has this status

Available options:
compatible_ucp_profile,
no_manifest,
no_compatible_version,
no_checkout,
timeout,
fetch_failed,
upstream_error,
invalid_profile
protocol
object | null
required

The protocol and version negotiated; null unless status is supported

capabilities
object[]
required

Allowlisted capabilities the merchant advertises; empty unless status is supported

checkedAt
string
required

When the merchant profile was fetched (ISO 8601)

Example:

"2026-10-16T23:00:00Z"

expiresAt
string
required

When this answer stops being fresh (ISO 8601)

Example:

"2026-10-16T23:05:00Z"

retryAfterSeconds
number | null
required

Whole seconds until expiresAt when status is unknown, otherwise null