Apple Pay

Information, requirements, and implementation details related to adding Apple Pay support to your application.

This page includes the following information about Payrix’s Apple Pay support:

Overview

What is it?
Apple Pay is an easy, fast and secure way to pay. Apple Pay replaces the need for your customers to take a physical card or type in your personal information during the sales process. Apple Pay is accepted by over 85% of retailers in the U.S and is a safe way to transact during social distancing.

We offer a turnkey solution that includes a no-lift enablement process with Apple allowing clients to accept Apple Pay with the click of a button instantly. It is a unique solution that is already built into our existing platform and requires little to no development work. We provide three options, an instant PayFrame solution, integrated Payfield solution or a fully customizable standalone button. This includes everything you need to directly implement the Apple Pay solution into a checkout flow for a fully customizable customer experience.

Cardholders must have a credit or debit card set up in their mobile wallet to use Apple Pay. The Apple Pay mobile wallet allows cardholders to store up to twelve different payment methods and provides the ability to create transactions without needing physical cards.

Prerequisites

Compatible browser and devices

Apple offers an integrated solution to your online shopping cart, allowing multiple payment options at the point of sale and improving the customer experience. Apple Pay’s online solution is compatible with the Safari browser and does not work with Microsoft Edge/IE or Google Chrome. We recommend downloading the latest version of Safari available, as noted below.

Safari on Mac running macOS Sierra or later

Mobile Safari on iOS 10.1 or later

Note, Safari supports Apple Javascript libraries (which are native to the Safari browser) so Apple Pay is not available in other web browsers.

Accepted Apple Device - Apple is compatible with iPhone, iPad or Mac, which have thumbprint or facial recognition capabilities. Find a full list of Apple Pay compatible devices HERE

Apple Pay Registration

To begin accepting Apple Pay, reach out to your service provider to complete the registration process. This is a process required by Apple and includes registering the merchant account and whitelisting your domain to accept Apple Pay transactions. This process will be completed by your service provider and is the first step to allow customers to pay using Apple pay.

Apple Pay registration is available directly in the portal allowing you to self-register and begin taking payments instantly. Please follow the steps below to begin the self-registration process.

Card Not Present (CNP)

Apple Pay is an innovative way to remove friction from the online checkout process, creating a fast, secure way for your customers to make payments online. It also improves security by utilizing biometric cardholder authentication and removing the need to input card data. We will work with you to create a customized Apple Pay solution to meet your needs.

PayFrame Example

PayField Example

Standalone Button Example

Card Present (CP)

For “brick and mortar” customers accepting card-present transactions, Apple Pay enables retail transactions. This option reduces friction at the point of sale, provides a contactless solution with multiple checkout options, increases sales, and improves your customer experience.

BB POS

For clients that would like to use Apple Pay as a contactless, mobile solution. We offer the bluetooth-compatible BB POS card swiper. This device allows you to pair your phone with the device to take card-present transactions in the field, increasing your sales velocity and security.

Partner Registration and Enablement

Apple Pay Registration and Domain Whitelisting

You can enable your merchants to use Apple Pay by completing a few easy steps. First, register the merchant and whitelist the domain that hosts the Apple Pay button. We have created a fast, easy process that will bulk register and whitelist all of your sub-merchants. Please use the steps below to complete the process and if you have any trouble, reach out to customer support.

Step 1: Access the Payment Method

In the settings section of the merchant portal, navigate to the payment methods to begin the registration process.

Step 2: Download Apple Pay Registration File

Download the domain registration file and upload it to your domain. Once this file is hosted on your website, Apple will verify your domain using the web address we have on file for you. If the website is not the domain creating the payment, either update the portal to match the correct domain or contact support for assistance.

You can also manually download the file below. Note, two files have been provided — one for production another for Sandbox testing; please use the correct file for your environment.

Download here:

Production domain registration file: https://api.domain.com/.well-known/apple-developer-merchantid-domain-association

Sandbox(test) registration file: https://test-api.domain.com/.well-known/apple-developer-merchantid-domain-association

Step 3: Host the file on your domain

To enable your merchants, add the verification file under that domain to host your Apple Pay Button. Next, Apple will confirm the file exists on the domain before registration and confirm where the transaction is coming from.

Example:

https://{DOMAIN}/.well-known/apple-developer-merchantid-domain-association

Step 4: Register your merchants

Complete the merchant registration and whitelisting the domain by selecting “register all.” This will send an API request to Apple that will confirm the file is hosted successfully and publish the button on the site. If the file is not hosted or the domain is not accurate, the registration will fail. If this happens, please check your credentials or reach out to support for assistance.

Step 5: Confirm Registration

Once completed, you will see the Apple Pay status for your merchants will be “Registered.” This response will be located in the API response and merchant portal.

Apple Pay Status - This is a field on the merchant table that will indicate the merchant is active and ready to transact using Apple Pay. When Apple Pay status is “Registered” the account is ready for use.

Step 6: Implement the solution of your choice

Apple Pay is available for multiple payment solutions. Please refer to the implementation guide for your desired solution.

PayFrame Solution

Introduction

For clients using PayFrames, we have created a secure, out-of-the-box solution to allow cardholders to input credit card information online seamlessly. By leveraging PayFrames, you will keep out of PCI scope. When enabling Apple Pay, the payment options will automatically display within the PayFrame without requiring additional integration work. It is designed this way to make it easy to use and implement, while drastically improving the customer experience.

Not yet using PayFrames? PayFrames can be created in the portal or by using the APIs.

https://portal.Domain.com/payFrameConfigurations

Demo:

For additional guidance, set up your PayFrame inside the sandbox view so you can preview how to embed the button inside the frame.

To test, use this code snippet to create a test PayFrame:

PayFrame.config.apiKey = "5e4ff3fc24164731f64541d0e429ec56";

PayFrame.config.merchant = "t1_mer_607d0c408cded2c12874f12";

PayFrame.config.hideBillingAddress = false;

PayFrame.config.amount = 100;

PayFrame.config.color = "c351e8";

PayFrame.config.mode = "txn";

</script>

PayField Solution

For clients using PayFields there is a simple and easy solution to add the Apple Pay payment option to your checkout flow. PayFields will allow your customers to select to input their card information or utilize Apple Pay at the point of sale.

Example (must be used in Safari):+++

https://api-qa.payrix.com/payfieldsExample.html

Step 1: Enable Apple Pay by registering the Merchant ID and Domain as shown in the implementation process. Shown above.

Step 2: Use the process outlined here to create your customized PayField payment solution.

Step 3A: Once you have created your PayField solution, you can add the Apple Pay JavaScript within the <head> tag on your payment page.

Step 3B: Once the Apple Pay JavaScript is added, add the Apple Pay button. This will style the button as shown in the demo above, then can be implemented and customized to match your checkout flow. To show the Apple Pay button include the code below:

Step 4: Style the button.

<style>

apple-pay-button {

--apple-pay-button-width: 150px;

--apple-pay-button-height: 30px;

--apple-pay-button-border-radius: 3px;

--apple-pay-button-padding: 0px 0px;

--apple-pay-button-box-sizing: border-box;

}

</style>

PayField Example:

<!DOCTYPE html>

<html>

<head>

<title>PayFrame Testing</title>

</head>

<body>

<h1>PayFrame Testing</h1>

</div>

// Merchant api key

PayFrame.config.apiKey = "71a78ab35ed4557cba6b78b87cc06d2c";

// Merchant id

PayFrame.config.merchant = "t1_mer_615f178d86f4634e392a915";

// Amount of Transaction

PayFrame.config.amount = '100';

// Setting Transaction type to auth

PayFrame.config.txnType = 'auth';

// Element of button is passed here as well as an optional value

// If no value is passed, default value will be used

PayFrame.config.button = {parent: "#submit", value: "Pay"};

// On Success we may execute code

PayFrame.onSuccess = function(response) {

console.log(response);

}

</script>

</body>

</html>

Step 5: Test the button and confirm the transaction is successful in your merchant portal or Via the API.

Standalone Apple Pay Button

Introduction

To provide you with greater control of the checkout experience for your merchants, we offer a “standalone” Apple Pay button option. This solution allows you to implement Apple Pay into your existing experience with a fully customized display inside the online checkout flow (for supported browsers).

Note, because this is a personalized solution, it requires light development work to implement. We’ve created a step-by-step guide here to make it easy for your engineering team to get Apple Pay up and running on the same day.

Technical Guide

After you complete the registration and whitelisting process with Apple, then you can build your custom Apple Pay solution.

Step 1: Create a checkout page using the PayFrame solution and add the standalone button

Ex:

<!DOCTYPE html>

<html>

<head>

<title>Standalone ApplePay Testing</title>

</head>

<body>

<h1>Standalone ApplePay Testing</h1>

<apple-pay-button buttonstyle="white-outline" type="plain" locale="en" style="display: block;"></apple-pay-button>

// Merchant api key

PayFrame.config.apiKey = "ca300a3dff5f1bbbee3878b41126cb4f";

// Merchant id

PayFrame.config.merchant = "000000000000007";

// Amount of Transaction

PayFrame.config.amount = '500';

// Setting Transaction type to auth

PayFrame.config.txnType = 'auth';

</script>

</body>

</html>

Step 2: Once the Apple Pay JavaScript is added, add the Apple Pay button. This will style the button as shown in the demo above, then can be implemented and customized to match your checkout flow. To show the Apple Pay button include the code below:

In the example above:

Step 3: Style the button.

<style>

apple-pay-button {

--apple-pay-button-width: 150px;

--apple-pay-button-height: 30px;

--apple-pay-button-border-radius: 3px;

--apple-pay-button-padding: 0px 0px;

--apple-pay-button-box-sizing: border-box;

}

</style>

Step 4: Test your solution and confirm you are able to create a successful Apple Pay transaction. If you are having trouble, please contact customer support.

Frequently Asked Questions

What is Apple Pay?

Apple Pay allows cardholders to add their eligible bank credit or debit cards to their phone to pay at participating retailers. When the card is added to your iPhone, the card number is converted to a unique number secured on a chip inside the phone. When you make a purchase, the merchant is passed this number instead of your card information, making the payment more secure.

What devices can I use with Apple Pay?

Apple Pay is available in iPhone 6 and later models, Ipad and Apple Watch.

Is Apple Pay secure?

Yes. Apple introduced a two-part security solution for Apple Pay. You must approve the transaction using biometric authentication. Plus, your credit card information is never stored on the device.

Will I be charged a fee for Apple Pay?

No, there is no additional charge to offer or use Apple Pay

Does Apple Pay work Online and In-Store?

Yes. Apple will work as a contactless payment solution in-store using an Apple Pay-enabled device, as well as in an eCommerce environment utilizing the Apple Device verification and authentication feature.

How Do I offer Apple Pay?

For a card-present or retail environment, your payment terminal must be enabled to accept Apple Pay and contactless payments. Payrix offers the BB POS mobile solution to accept Apple Pay transactions.

For an eCommerce environment, the partner/merchant must register their domain with Apple and implement the payment solution into the checkout flow. Payrix offers Apple pay in all of its current online payment solutions and the option to create a custom solution tailored to your company's brand.

Will it work on my Android phone or Chrome browser?

No, Apple Pay is only compatible with Apple devices and the Safari browser.

Can I use Apple Pay to create an Auth/Capture workflow?

No, Apple Pay is only used to run a SALE for cardholders.

Will Apple Pay create a token that I can save for my cardholders

Currently, the application does not support the creation of a separate and unique token for future use when using Apple Pay.