POST/v1/apple_pay/domains

Create an Apple Pay domain

Creates a new Apple Pay domain for your account. The domain must be provided and will be registered for use with Apple Pay payments. Returns the created domain object with its unique identifier.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Apple Pay domain details.

domain_namestringrequired

The domain name to register for Apple Pay.

expandarray<string>optional

Specifies which fields in the response should be expanded.

2 status codes
200Returns the created Apple Pay domain object with its unique identifier, creation timestamp, and livemode status.
createdintegerrequired

Time at which the object was created. Measured in seconds since the Unix epoch.

domain_namestringrequired
idstringrequired

Unique identifier for the object.

livemodebooleanrequired

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:apple_pay_domain
defaultError response.
errorobjectrequired

Error handling

domain_name is required and must be a valid domain string.