Sign in
latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

Payment Method Domains

Create Payment Method Domain

Registers a hostname with the wallet provider and attempts verification inline. Returns verified when the provider fetched the domain-association file (for Apple Pay, /.well-known/apple-developer-merchantid-domain-association), or pending when it could not — host the file, then retry with the verify endpoint.

post/payment_method_domains

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

Account to register the domain for (biz_ tag). Defaults to the caller's account.

hostnamestring required

Hostname to register (e.g. checkout.shinetime.example).

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "hostname": "pending.shinetime.example"
}

Response

domain registered as pending when verification fails

account_idstring nullable required

ID of the account the domain is registered for, prefixed biz_.

created_atstring required

When the domain was created, as an ISO 8601 timestamp.

hostnamestring required

Hostname the checkout is served from (e.g. checkout.example.com).

idstring required

Payment method domain ID, prefixed pmd_.

provider'apple' required

Wallet provider the domain is registered with.

status'pending' | 'verified' required

Verification status. pending means the provider could not fetch the domain-association file yet; only verified domains show wallet payment methods at checkout.

updated_atstring required

When the domain was last updated, as an ISO 8601 timestamp.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "hostname": "checkout.shinetime.example",
  "id": "pmd_xxxxxxxxxxxxxx",
  "provider": "apple",
  "status": "verified",
  "updated_at": "2026-01-01T12:00:00.000Z"
}