Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Apple Pay

Register a domain for Apple Pay

Registers a domain name for Apple Pay on the web. Note that this is required if relying on Ryft's Apple Pay processing certificate.

A Maxiumum of 99 domains can be registered against a single Ryft account.

Each domain must host our verification file under /.well-known/apple-developer-merchantid-domain-association.

Important: the Content-Type of the hosted file must be application/octet-stream.

post/apple-pay/web-domains

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this if you are processing payments directly under a sub account's URL)

Request body

domainNamestring required

The domain name you want to register for Apple Pay.

Example request

{
  "domainName": "ryftpay.com"
}

Response

Apple Pay web domain successfully created

idstring

The unique ID for the web domain

domainNamestring

The domain name registered for Apple Pay

createdTimestampinteger

The epoch timestamp (seconds) when the apple pay web domain was created

Example response

{
  "id": "apwd_01FCTS1XMKH9FF43CAFA4CXT3P",
  "domainName": "ryftpay.com",
  "createdTimestamp": 1631696701
}