Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Not all gateways support Apple Pay. Apple Pay is supported on Adyen, Bambora, Checkout (V2), NMI, Square, Stripe, Surgeify, Vantiv, and Verifi.

Note

Apple Pay setup requires successful configuration of your Apple Pay Certificates, Identifiers & Profiles in your Apple Developer account. You can find more information on how to properly configure your Apple Pay account on the Apple side in the Apple Developer docs: Configure Apple Pay

Note

Payments cannot be processed without a valid Payment Processing Certificate from your Gateway. You will upload your Gateway’s Payment Processing Certificate (a “csr” file with a .certSigningRequest file extension) to your Apple Developer account.

Info

The button ONLY displays if customer's Apple Pay wallet is configured AND device supports Apple Pay (mac or iphone with touch ID).

...

  • Your Apple Pay Merchant Identity Certificate

  • This must be downloaded from your Apple Account and converted to PEM format

    • One option to convert to PEM is as follows:

      • On the Mac, open Keychain Access

      • From the sidebar, select System Roots

      • Locate the certificate to export

      • Select File > Export Items

      • Select a location to save the certificate and select the Privacy Enhanced Mail (.pem) file format

  • Open your new PEM file in a text editor, like Notepad. Copy the contents of the text file and paste into the “merchantCert” box.

  • Pasted text must include everything from “-----BEGIN CERTIFICATE-----” to “-----END CERTIFICATE-----”.

certPrivateKey:

  • The private key of your Merchant Identity Certificate

  • This must be converted to PEM format along with your downloaded Apple Pay Merchant Identity Certificate

  • Open your new PEM file in a text editor, like Notepad. Copy the contents of the text file and paste into the “certPrivateKey” box

  • Pasted text must include everything from “-----BEGIN PRIVATE KEY-----” to “-----END PRIVATE KEY-----”.

displayName:

  • Default merchant name to display to the customer while authorizing payment

    • Ex: "Touch ID to Pay My Store (displayName) $118.00"

...

  • Gateway: Gateway on which to process a transaction the with Apple Pay token. Gateway is optional. Not entering a gateway will process the transaction on the gateway assigned to the product purchased. Do ensure the gateway is in the supported list at the top of this document. Also ensure you have uploaded a valid Payment Processing Certificate from your Gateway in your Apple Developer account.

  • Plugin: Apple Pay plugin / Merchant ID configuration settings to use to create Apple Payment Sessions. This is required.

  • Merchant Name: Customizable funnel merchant name to display to the customer while authorizing payment. If not entered, the session will default to the plugin settings displayName.

    • Ex: "Touch ID to Pay My Store (displayName) $118.00"

  • Country: Country to use for Apple Pay Session

  • You will upload Domain File in Step 9.

...