Menu

Apple Pay (Hosted)

This guide assumes you have a Hosted Payment Page integration with Worldpay. If you do not, talk to your Worldpay Relationship Manager or Support Team before you proceed.

Prerequisites

Before you begin, you must:

Full page redirect or iFrame/Lightbox redirect

If you use our full page redirect, the process is self serve. Go straight to theWorldpay MAI guidefor instructions on enabling Apple Pay on your Worldpay account.

For iFrame/Lightbox redirects, follow the steps in this guide before you complete the setup in the Worldpay MAI.

Full page redirect

You must request boarding to Apple Pay through the Worldpay MAI. Refer to theWorldpay MAI guidefor details.

Worldpay complete the boarding process with Apple on your behalf.

iFrame or Lightbox

For iFrame and Lightbox integrations you must:

  • Verify your domain with Apple Pay
  • Integrate with the Worldpay API
  • Configure your merchant account in the Worldpay MAI

Before you register your domains with Apple you must addthis fileto each domain. Put the file on your domain at this path: /.well-known/apple-developer-merchantid-domain-association.

To complete registration and the integration process, follow the instructions in theMAI guide.

Note: Domains are auto registered against all merchant codes.

Example XML request

Here's a basic example of the data submitted for a card test payment. Before you send it, change the merchantCode to your own, and be aware that each payment requires a unique orderCode:

Copied!
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE paymentService PUBLIC "-//Worldpay//DTD Worldpay PaymentService v1//EN" "http://dtd.worldpay.com/paymentService_v1.dtd">
<paymentService version="1.4" merchantCode="YOUR_MERCHANT_CODE"> <!--Enter your own merchant code-->
   <submit>
      <order orderCode="YOUR_ORDER_CODE" installationId="1234567"> <!--installationId identifies your Hosted Payment Page-->
         <description>YOUR_DESCRIPTION</description> <!--Enter a description useful to you-->
         <amount currencyCode="GBP" exponent="2" value="5000" />
         <orderContent><![CDATA[AMOREDETAILEDDESCRIPTIONOFYOURORDERCONTENTCANGOHERE]]></orderContent>
         <paymentMethodMask>
            <include code="ALL" />
         </paymentMethodMask>
         <shopper>
            <shopperEmailAddress>jshopper@myprovider.com</shopperEmailAddress>
         </shopper>
         <shippingAddress>
            <address>
               <address1>47A</address1>
               <address2>Queensbridge Road</address2>
               <address3>Suburbia</address3>
               <postalCode>CB94BQ</postalCode>
               <city>Cambridge</city>
               <state>Cambridgeshire</state>
               <countryCode>GB</countryCode>
            </address>
         </shippingAddress>
         <billingAddress>
            <address>
               <address1>47A</address1>
               <address2>Queensbridge Road</address2>
               <address3>Suburbia</address3>
               <postalCode>CB94BQ</postalCode>
               <city>Cambridge</city>
               <state>Cambridgeshire</state>
               <countryCode>GB</countryCode>
            </address>
         </billingAddress>
      </order>
   </submit>
</paymentService>

Response

The response message is the same as ourstandard XML responses.

Payment page designer

Customise the look and feel of the Apple Pay button (text and scheme).

Test

Worldpay’s test environment supports the use of Apple’s Sandbox Tester accounts and the sandbox test cards (Mastercard, Maestro, Visa, Amex and Discover) provided by Apple.

More details are at:https://developer.apple.com/support/apple-pay-sandbox

All Apple Pay transactions processed against the Worldpay test environment receive an AUTHORISED response status.

Some links to Apple Pay websites.

Apple Pay: Your Wallet. Without the wallet

Worldpay/Apple Pay

Developer: Apple Pay Resources

Developer: Apple Pay Developer Forums