Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
ApplePay

RegisterDomain

Activates a domain for use with Apple Pay on the Web and Square. A validation is performed on this domain by Apple to ensure that it is properly set up as an Apple Pay enabled domain.

This endpoint provides an easy way for platform developers to bulk activate Apple Pay on the Web with Square for merchants using their platform.

To learn more about Web Apple Pay, see Add the Apple Pay on the Web Button.

post/v2/apple-pay/domains

Request body

domain_namestring required

A domain name as described in RFC-1034 that will be registered with ApplePay.

Example request

{
  "request_body": {
    "domain_name": "example.com"
  }
}

Response

Success

statusstring

The status of the domain registration.

See RegisterDomainResponseStatus for possible values.

Example response

{
  "status": "VERIFIED"
}