Apple Merchant

The Apple Merchant API provides functionality for managing Apple Pay for Web integration through Xplor Pay's payment gateway. This API allows merchants to register domains, validate merchant sessions, and retrieve merchant details for Apple Pay transactions.

Base URLs

Environment	URL
Sandbox	https://gateway-sb.clearent.net/rest/
Production	https://gateway.clearent.net/rest/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay
PublicKey: Public key value provided by Xplor Pay

Available endpoints

• Get Merchant Details: GET /rest/v2/apple/merchants

• List Registered Domains: GET /rest/v2/apple/merchants/domains

• Register Domain(s): POST /rest/v2/apple/merchants/domains

• De-register Domain(s): DELETE /rest/v2/apple/merchants/domains

• Get Apple Merchant Session: POST /rest/v2/apple/merchants/validation

Usage Information

1

Managing Domains

Before you can initiate any Apple Pay sessions, you need to register the domains. This is done by creating an association between the merchant, Xplor Pay, Apple, and a specific domain. Use the three /rest/v2/apple/merchants/domains endpoints to:

• Register one or more domains (POST)

• Deregister one or more domains (DELETE)

• List registered domains (GET)

2

Retrieving Merchant Details

The /rest/v2/apple/merchants endpoint will provide details on what Apple is currently aware of regarding a merchant.

3

Obtaining an Apple Pay Session

Use the /rest/v2/apple/merchants/validation endpoint once your domain is registered and you’re ready to initiate an Apple Pay for Web session (e.g. run an Apple Pay transaction).

Note: If you are using an Apple Developer account, then it will only use the https://apple-pay-gateway-cert.apple.com as the validationURL.