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 access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/apple-pay.write
scope.
POST
/accounts/{accountID}/apple-pay/domains
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
{
"accountID": "string",
"displayName": "string",
"domains": [
"checkout.classbooker.dev"
],
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
"error": "string"
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Apple Pay domains are already registered for this account.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The requested domains were not verified.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
Specify an API version.
API versioning follows the format vYYYY.QQ.BB
, where
YYYY
is the yearQQ
is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BB
is the build number, starting at.01
, for subsequent builds in the same quarter.- For example,
v2024.01.00
is the initial release of the first quarter of 2024.
- For example,
The latest
version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
Default:
v2024.01.00
Path parameters
accountID
string
<uuid>
required
ID of the Moov account representing the merchant.
Body
application/json
displayName
string
<=64 characters
A UTF-8 string to display in the Buy button.
domains
array
A unique list of fully-qualified, top-level or sub-domain names where you will accept Apple Pay.
Response
application/json
accountID
string
required
createdOn
string<date-time>
required
displayName
string
<=64 characters
required
A UTF-8 string to display in the Buy button.
domains
array
required
A unique list of fully-qualified, top-level or sub-domain names where you will accept Apple Pay.
updatedOn
string<date-time>
required