Skip to main content
POST
Register an Apple Pay web domain

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>

Optional idempotency key. Sending again with the same key returns the same result without re-executing the registration. If omitted, one is generated automatically, so retries are not automatically deduplicated unless the caller supplies its own key.

Body

application/json
domainName
string
required

Domain to register for Apple Pay web, without a scheme (e.g. checkout.example.com, not https://checkout.example.com). The domain must already host Apple's .well-known/apple-developer-merchantid-domain-association file before registration succeeds.

Example:

"checkout.example.com"

Response

Success.

The response is of type object.