Legacy Apple Pay Setup (Apple Pay Plugin)
Last updated
Last updated
Not all gateways support Apple Pay. Apple Pay is supported on Acquired3DS, Adyen, Authorize.netV2, Bambora, cardstream, Celerispay, CheckoutV2, Easy Pay Direct, Gala Technology, Merchant Warrior, MerchantConnect, MerchantConnectV2, NMI, NomuPay, PaysafeV2, Priority, SquareV2, SquareV2, StripeV2, Surgeify, Swipen, TotalApps, Truevo, Vantiv, VantivV2, Verifi, Whitelabel Payments, WorldlineV2, Worldpay.
This Apple Pay setup method should only be used if you are using your own Apple Pay Developer Account with the Apple Pay plugin.
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
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.
Please Note: Your Gateway’s Payment Processing Certificate EXPIRES every 25 months. You will need to generate and upload a NEW certificate to your Apple Developer account prior to the expiration date.
merchantIdentifier:
Your Apple Pay Merchant Identifier
Can be found on your Apple Developer Account at https://developer.apple.com/account/resources/identifiers/list/merchant
Download your Merchant Identity Certificate and its Private Key
To download your Merchant Identity Certificate and its Private Key, first open Keychain Access.
Navigate to the “Certificates” section.
Highlight both the certificate and the key (down arrow).
Right click.
Export 2 items.
File format Personal Information Exchange (.p12)
Convert the .p12 file to PEM format
Launch the terminal on your Mac.
Change directory to the folder where you have saved the .p12 file.
Run the following openssl pkcs12 command to generate a .pem file:
openssl pkcs12 -in pushcert.p12 -out pushcert.pem -nodes -clcerts
merchantCert:
Your Apple Pay Merchant Identity Certificate
As noted above, this must be downloaded from your Apple Account and converted to PEM 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.
Go to https://developer.apple.com/account/resources/identifiers/list/merchant and select the Merchant ID that you are using with this funnel.
On the Edit or Configure Merchant ID page, go to Merchant Domains section and click Add Domain.
Enter your funnel domain and save.
Click Download and download the apple-developer-merchantid-domain-association txt file.
On your funnel Payments settings, click Choose File next to the Domain File label.
Select your downloaded verification text file and click Open.
Publish the funnel. This will upload the file to the .well-known folder on your funnel.
Click Verify back on your Apple Merchant Domain page.
When using Apple Pay in multiple funnels published to the same domain, you will need to upload the file to a single funnel and publish that funnel as the default funnel.
Option 1:
Your gateway supports a 1-click upsell on Apple Pay using a payment token returned from the gateway at checkout
Place one or more standard buttons on each upsell page. Follow standard instructions for those buttons to submit the upsell. Add class cc-one-click-btn to each button. There is no need to have an Apple Pay button on each page. The buttons will submit using the original payment token.
Option 2:
Your gateway does not support Option 1. You prefer to have a generic button on upsell pages instead of an Apple button.
Place one or more standard buttons on each upsell page. Follow standard instructions for those buttons to submit the upsell. The buttons will automatically support Apple Pay or non-Apple Pay based on the checkout. Apple Pay will redirect the consumer to Apple to complete the upsell. No additional work is needed.
Option 3:
Your gateway does not support Option 1. You prefer to have an Apple button on upsell pages.
Place one or more standard buttons AND one or more Apple Pay buttons on each upsell page. Choose all the buttons on the arrow(s) leaving the page. When the live page loads the standard buttons are removed if the checkout was with Apple Pay. Pressing the Apple Pay buttons will redirect the consumer to Apple to complete the upsell. When the live page loads the Apple Pay buttons are removed if the checkout was not Apple Pay. The standard buttons will submit the upsell.
Apply Pay checkout is available only on Apple devices. Apple Pay buttons on a live page will only display on Apple devices. https://support.apple.com/en-us/HT208531
