Apple Pay for Web

Apple Pay for Web lets you accept payments from customers using the Safari browser on their iOS devices.

The following sections explain how to integrate Apple pay on your website.

Prerequisites

Make sure the following requirements are met before integrating Apple Pay and accepting payments on your website:

• A MacBook running macOS 10.12.1 or later

• An iPhone running iOS 10.1 or later

• Safari browser

• A server that supports Apple Pay

• An application served over HTTPS in both development and production environments

• A valid SSL-certified domain

• A server that supports Transport Layer Security (TLS) version 1.2 or later

Refer to the Apple Server Configurations for setting up your production environment.

Always implement manual card entry in the JavaScript SDK as a fallback option.

Supported Payment Methods

You can collect the payment and address information of your customers who use Apply Pay.

Supported Cards

• Visa

• MasterCard

• American Express

• Discover

Merchant Capabilities

• Credit cards (Visa or Mastercard)

• Debit cards (Visa or Mastercard)

Unsupported Payment Methods

• In-App Payments

• Recurring Payments

• Split Shipment

• Voids/Refunds through Apple Pay

Getting Started

Clearent handles the Merchant Validation process for you by creating an Apple Merchant ID and Certificate Signing Request. For more information, see Apple Developer Documentation.

To register and verify your domain with Apple:

1. Provide your domain(s) that will be used for Apple Pay.

2. Host the verification file provided by Clearent to you on the following URL, replacing [DOMAIN_NAME] with your domain name.

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

This URL must be publicly accessible to allow Apple to verify the file.

1. Send the hosted file with the appropriate URL to register and verify your domain with Apple.

2. Clearent will confirm once your domain is successfully verified.

Setting Up Apple Pay

Adding the Apple Pay Button

1

Create a container on your website to add the Apple Pay button with the default style.

<button id="apple-pay-button" class=""></button>

Apple provides several types of buttons so that you can choose the button type that fits best with the terminology and flow of your purchase or payment experience. For more information on Apple Styling Guidelines, see Apple Pay.

To request button type for your website:

{
    "total": {
        "label": "AAA",
        "type": "final",
        "amount": "1.99"
    }
}

2

Add the function to check whether your customer uses Apple Pay. This function helps you decide whether to display the Apple Pay button in the customer’s browser.

ClearentSDK.applePayAvailable()

Configuring the onClick Event

To configure the onClick event for your payment process:

1

Add the onClick object into your payment sheet to start the Apple Pay session.

if(ClearentSDK.applePayAvailable()) {
  let applyPaymentSheet = YOUR_PAYMENT_SHEET
  jq2("#apple-pay-button").on("click", () => {
      const session = ClearentSDK.buildApplePaySession(applyPaymentSheet);
// optional dynamic handling events can be added here (see below for details)
      session.begin()
  });
}

2

The JavaScript SDK handles the Apple Pay token and converts it into a JSON Web Token (JWT).

function ClearentTokenSuccess(raw, json) {
    console.log("ClearentTokenSuccess");
    console.log(raw);
    console.log(json);
    console.log("-----------------------------------------------");
    console.log("now you can send the token to your server");
    console.log("to complete the transaction via mobile-gateway");
    console.log("-----------------------------------------------")
}
function ClearentTokenError(raw, json) {
    console.log("ClearentTokenError");
    console.log(raw);
    console.log(json);
}

Before moving to the next step, ensure you have integrated with JavaScript SDK to avoid an error. For more information, see JavaScript SDK.

3

Send the JSON Web Token (JWT) to your server using a secure connection.

4

Provide the secret API key to Clearent from your server.

Don’t expose the secret API key in your website code.

5

Clearent returns a successful token response.

6

Send the token response to the JavaScript SDK for handling.

Testing Apple Pay for Web

Apple requires an offline test implementation of Apple Pay for apps, websites, and point-of-sale systems.

You can test your Apple Pay transaction using the Sandbox testing reference.

Calculating Final Transaction Cost

You can calculate final transaction cost using customer’s payment method, billing address, shipping address, and shipping method:

• If you want to calculate the final transaction cost using payment method, add the onpaymentmethodselected optional handler in your payment sheet.
• If you want to calculate the final transaction cost using shipping method, add the onshippingmethodselected optional handler in your payment sheet.
• If you want to calculate the final transaction cost using billing address and shipping address, add the onshippingcontactselected optional handler in your payment sheet.

You can add the optional oncancel handler, which triggers when the customer clicks the Cancel button, to cancel the Apple Pay session.

Refer the following example to implement the optional handlers in your payment sheet:

Example:

jq2("#apple-pay-button").on("click", () => {
    const session = ClearentSDK.buildApplePaySession(request);
  session.onshippingmethodselected = function (event) {
    selectedShippingMethod = event.shippingMethod
    const newTotalAmount = calculateTotal….
    const newLineItems = [update line items…]
    session.completeShippingMethodSelection(
      {
        newTotal: {
          label: request.total.label,
          amount: newTotalAmount,
          type: final }, // newTotal is required
        newLineItems,
      }
    )
  }
   session.oncancel = function(event) {
       …add logic for when session is cancelled by user
}
…. Other optional handlers can be added here
    session.begin()
});