Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Sources
  3. Apple Pay

Register domains for Apple Pay

Add domains to be registered with Apple Pay.

Any domains that will be used to accept payments must first be verified with Apple.

To use this endpoint from the browser, you’ll need to specify the /accounts/{accountID}/apple-pay.write scope when generating a token.
POST
/accounts/{accountID}/apple-pay/domains
cURL 
1
2
3
4
5
6
7
8

curl -X POST "https://api.moov.io/accounts/{accountID}/apple-pay/domains" \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "displayName": "Example Merchant",
    "domains": [
      "checkout.classbooker.dev"
    ]
  }'\
200 400 409 417 429
Domains registered with Apple Pay.
{
  "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
  "createdOn": "2019-08-24T14:15:22Z",
  "displayName": "Example Merchant",
  "domains": [
    "checkout.classbooker.dev"
  ],
  "updatedOn": "2019-08-24T14:15:22Z"
}
The request body was invalid.
Apple Pay domains already registered for this account.
Domain(s) not verified with Apple.
Request was refused due to rate limiting.

Response headers

Retry-After

number

Path parameters

accountID

string <uuid> required
ID of the Moov account acting as a merchant in a card transaction.

Body

application/json

displayName

string <=64 characters required
A string of 64 or fewer UTF-8 characters. Displayed in the Buy button.

domains

array required
A list of fully qualified top-level or sub-domain names where you will accept Apple Pay. Items must be unique.

Response

application/json

accountID

string<uuid> <=36 characters
ID of account.

createdOn

string<date-time> <=24 characters

displayName

string <=64 characters
A string of 64 or fewer UTF-8 characters. Displayed in the Buy button.

domains

array
A list of fully qualified top-level or sub-domain names where you will accept Apple Pay.

updatedOn

string<date-time> <=24 characters