v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Apple Pay

Create an Apple Pay web session

Request a new Apple Pay web session. Use this endpoint if you process Apple Pay on the web and:

you want to rely on Ryft's Apple Pay processing certificate
have an existing integration or want to implement Apple Pay via our API (without using our SDKs)

post/apple-pay/sessions

Accountstring

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

The linked accountId (use this if you are processing Apple Pay directly under a sub account's registered Apple Pay domain)

displayNamestring required

This is the name displayed within the Apple Pay payment sheet. Must contain UTF-8 characters.

domainNamestring required

The domain name you have verified for Apple Pay (omit the protocol). This should match window.location.hostname.

{
  "displayName": "Ryft Merchandise",
  "domainName": "ryftpay.com"
}

Apple Pay session successfully created

sessionObjectstring

The opaque Apple Pay session object. This will be a JSON escaped string.

{
  "sessionObject": "..."
}