Prerequisites

The following is required for a Apple Pay™ API integration:

• An active merchant account with our Payment Gateway
• Your Ecentric API credentials (API Key and Secret)
• An Apple Developer Account (API merchants offering native iOS support)

Apple Pay Demo

Apple's official demo page showcases functionality and configuration options.

Apple Pay Demo

Supported Browsers and Card Networks

• Apple Pay availability depends on device and browser compatibility.
  • A list of supported browsers and devices can be found here.

• This returns a token with a 3D Secure cryptogram.

Allowed Card Networks

• VISA
• MASTERCARD
• AMEX

These will be used in your integration when you define the supportedNetworks when implementing the Apple Pay button

API only merchants (no iOS native apps support)

API web merchants that do not process payments using a native iOS App are not required to register for an Apple Developer profile themselves.

• Ecentric will onboard the merchant for Apple Pay.
• Once approved, Ecentric will enable the payment option.
• The merchant must provide Ecentric with the list of domain they wish to register for Apple Pay.
• Ecentric will provide the merchant with a Domain Verification File.

  • This must be hosted by the merchant site initiating the Apple Pay Button.

    https://DOMAIN_NAME/.well-known/apple-developer-merchantid-domain-association

• The merchant will have to implement the Apple Pay button script (See Below)
• Upon receiving the Apple Pay encrypted payload post customer authentication:
  • Pass The Encrypted Payload to the Gateway
    • Merchants will pass the encrypted payload received from Apple to Ecentric in an Authorize or Payment request in the DigitalWalletPayload field.

API merchants and iOS native app support

Merchants who already have their own Apple Developers profile can provide specific details to Ecentric to enable them to Process Apple Pay transactions.

Merchants who wish to make use of a native iOS App to process Apple Pay transactions MUST have their own Apple Pay profile.

• Ecentric will need to provide the merchant with a CSR file (certificate signing request).
  • This will be provided to the merchant in the enablement phase.
  • The merchant will use the CSR file to generate a Payment Processing Certificate.
  • Merchant generated Payment Processing Certificate must be shared with Ecentric.
  • The merchant will have to implement the Apple Pay web button script (See Below)
    • For merchants implementing Apple Pay into their iOS App, see here
  • Upon receiving the Apple Pay encrypted payload post customer authentication:
    • Pass The Encrypted Payload to the Gateway
      • Merchants will pass the encrypted payload received from Apple to Ecentric in an Authorize or Payment request in the DigitalWalletPayload field.

Apple Developer Registration and setup.

API merchants who wish to offer Apple Pay on the web and using a native iOS app must follow the below steps in order to offer Apple Pay to their customers.

Apple Developer Registration Guide

Configure Apple Pay on the web - Capabilities - Account - Help - Apple Developer

• Visit https://developer.apple.com and register the merchant under their Apple ID.
• The merchant must register with Apple in order to host the Apple Pay button for native iOS apps.

Create a Merchant Identifier

Configure Apple Pay on the web - Merchant Identifier

• Create this in your developer account → Certificates, Identifiers & Profiles
• It uniquely identifies you to Apple Pay as a merchant who is able to accept payments.

Create the Payment Processing Certificate

Configure Apple Pay on the web - Payment Processing Certificate

• The certificate is associated to your merchant identifier and used to encrypt payment information.
• Ecentric will provide the merchant with a CSR file
  • The merchant will use the CSR to generate the Payment Processing Certificate.
  • The merchant will share the Payment Processing Certificate with Ecentric.

Register the merchant domain

Configure Apple Pay on the web - Merchant Domain

Within the merchants Apple Pay profile → Certificates, Identifiers & Profiles

• Select Identifiers in the left sidebar, then select Merchant IDs from the pop-up menu on the top right.

• On the right, select your merchant identifier.
• Under Merchant Domains, click Add Domain.
• Enter the fully qualified domain name, then click Save.
  • Click Download, place the downloaded file in the specified location, then click Verify.
  • Click Done.
• Merchants must remember to verify the domain else the Apple Pay button validation will fail.

Create a merchant identity certificate

Configure Apple Pay on the Web - Identity Certificate

Implementing The Apple Pay Button (Web only)

Use the Apple Pay Demo as guide.

Merchants must remember to follow Apple's guidelines on branding, button placement and design.

• Details on button design can be found here.
• Please also keep in mind any restrictions as described here.
• Merchants can find guidance on Apple Pay marketing here.

Follow the Apple Pay developers documentation and implement the Apple Pay button using either:

• Apple Pay JS API
• Payment Request API

{
    "supportedMethods": "https://apple.com/apple-pay",
    "data": {
        "version": 3,
        "merchantIdentifier": "merchant.com.apdemo",
        "merchantCapabilities": [
            "supports3DS"
        ],
        "supportedNetworks": [
            "amex",
            "masterCard",
            "visa"
        ],
        "countryCode": "ZA"
    }
}