You are viewing an old version of the API
Register domain

Activates a domain for use with Web Apple Pay and Square

A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.

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

To learn more about Apple Pay on Web see the Apple Pay section in the Square Payment Form Walkthrough.


Request Body

Name Description
domain_name
string

Required

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

Max Length 255 Min Length 1

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

status
string

Status of the domain registration.

Examples

You are viewing an old version of the API
POST /v2/apple-pay/domains
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/apple-pay/domains \
  -X POST \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -d '{
    "domain_name": "example.com"
  }'
Response JSON
{
  "status": "VERIFIED"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?