Apple Pay

Payment experience

1. In countries in which Apple Pay is supported, the option to add a card to the wallet on the device of the consumer will be enabled. The consumer can add her/his payment details as well as shipping and billing address in the app..
   

2. Within an app that supports Apple Pay, the button “Buy with Apple Pay” will appear when the consumer is ready to checkout.

3. The card details of the consumer are visible and can be changed upon wish of the consumer. Next to that the total amount is also displayed. The consumer will need to use Touch ID to validate the payment.

4. Once the payment is validated it will be sent via the typical purchase flow, so that we can process this payment.

Countries & currencies

Supported countries

• Australia
• Belgium
• Brazil
• Bulgaria
• Canada
• China
• Croatia
• Cyprus
• Czech Republic
• Denmark
• Estonia
• Finland
• France
• Germany
• Guernsey
• Heard Island and McDonald Islands
• Hong Kong
• Ireland
• Isle of Man
• Italy
• Japan
• Jersey
• Kazakhstan
• Latvia
• Liechtenstein
• Lithuania
• Malta
• Monaco
• Netherlands
• New Zealand
• Norway
• Poland
• Portugal
• Romania
• Russia
• San Marino
• Singapore
• Slovakia
• Slovenia
• Spain
• Sweden
• Switzerland
• Taiwan
• Ukraine
• United Arab Emirates
• United Kingdom
• United States Minor Outlying Islands
• United States
• Vatican City

Supported currencies

• Albanian lek (ALL)
• Algerian dinar (DZD)
• Angolan kwanza (AOA)
• Argentine peso (ARS)
• Armenian dram (AMD)
• Aruban florin (AWG)
• Australian dollar (AUD)
• Azerbaijani manat (AZN)
• Bahamian dollar (BSD)
• Bahraini dinar (BHD)
• Bangladeshi taka (BDT)
• Barbados dollar (BBD)
• Belarusian ruble (BYN)
• Belize dollar (BZD)
• Bermudian dollar (BMD)
• Bhutanese ngultrum (BTN)
• Boliviano (BOB)
• Bosnia and Herzegovina convertible mark (BAM)
• Botswana pula (BWP)
• Brazilian real (BRL)
• Brunei dollar (BND)
• Bulgarian lev (BGN)
• Burundian franc (BIF)
• Cambodian riel (KHR)
• Canadian dollar (CAD)
• Cape Verde escudo (CVE)
• Cayman Islands dollar (KYD)
• CFA franc BCEAO (XOF)
• CFA franc BEAC (XAF)
• CFP franc (franc Pacifique) (XPF)
• Chilean peso (CLP)
• Chinese yuan (CNY)
• Colombian peso (COP)
• Comoro franc (KMF)
• Congolese franc (CDF)
• Costa Rican colon (CRC)
• Croatian kuna (HRK)
• Czech koruna (CZK)
• Danish krone (DKK)
• Djiboutian franc (DJF)
• Dominican peso (DOP)
• East Caribbean dollar (XCD)
• Egyptian pound (EGP)
• Eritrean nakfa (ERN)
• Ethiopian birr (ETB)
• Euro (EUR)
• Falkland Islands pound (FKP)
• Fiji dollar (FJD)
• Gambian dalasi (GMD)
• Georgian lari (GEL)
• Ghanaian cedi (GHS)
• Gibraltar pound (GIP)
• Guatemalan quetzal (GTQ)
• Guinean franc (GNF)
• Guyanese dollar (GYD)
• Haitian gourde (HTG)
• Honduran lempira (HNL)
• Hong Kong dollar (HKD)
• Hungarian forint (HUF)
• Icelandic króna (ISK)
• Indian rupee (INR)
• Indonesian rupiah (IDR)
• Iraqi dinar (IQD)
• Israeli new shekel (ILS)
• Jamaican dollar (JMD)
• Japanese yen (JPY)
• Jordanian dinar (JOD)
• Kazakhstani tenge (KZT)
• Kenyan shilling (KES)
• Kuwaiti dinar (KWD)
• Kyrgyzstani som (KGS)
• Lao kip (LAK)
• Lebanese pound (LBP)
• Lesotho loti (LSL)
• Liberian dollar (LRD)
• Libyan dinar (LYD)
• Macanese pataca (MOP)
• Macedonian denar (MKD)
• Malagasy ariary (MGA)
• Malawian kwacha (MWK)
• Malaysian ringgit (MYR)
• Maldivian rufiyaa (MVR)
• Mauritanian ouguiya (MRO)
• Mauritian rupee (MUR)
• Mexican peso (MXN)
• Moldovan leu (MDL)
• Mongolian tugrik (MNT)
• Moroccan dirham (MAD)
• Mozambican metical (MZN)
• Myanmar kyat (MMK)
• Namibian dollar (NAD)
• Nepalese rupee (NPR)
• Netherlands Antillean guilder (ANG)
• New Taiwan dollar (TWD)
• New Zealand dollar (NZD)
• Nicaraguan córdoba (NIO)
• Nigerian naira (NGN)
• Norwegian krone (NOK)
• Omani rial (OMR)
• Pakistani rupee (PKR)
• Panamanian balboa (PAB)
• Papua New Guinean kina (PGK)
• Paraguayan guaraní (PYG)
• Peruvian nuevo sol (PEN)
• Philippine peso (PHP)
• Polish zloty (PLN)
• Pound sterling (GBP)
• Qatari riyal (QAR)
• Romanian new leu (RON)
• Russian ruble (RUB)
• Rwandan franc (RWF)
• Saint Helena pound (SHP)
• Salvadoran Colon (SVC)
• Samoan tala (WST)
• São Tomé and Príncipe dobra (STD)
• Saudi riyal (SAR)
• Serbian dinar (RSD)
• Seychelles rupee (SCR)
• Sierra Leonean leone (SLL)
• Singapore dollar (SGD)
• Solomon Islands dollar (SBD)
• Somali shilling (SOS)
• South African rand (ZAR)
• South Korean won (KRW)
• Sri Lankan rupee (LKR)
• Surinamese dollar (SRD)
• Swazi lilangeni (SZL)
• Swedish krona/kronor (SEK)
• Swiss franc (CHF)
• Tajikistani somoni (TJS)
• Tanzanian shilling (TZS)
• Thai baht (THB)
• Tongan paʻanga (TOP)
• Trinidad and Tobago dollar (TTD)
• Tunisian dinar (TND)
• Turkish lira (TRY)
• Turkmenistani manat (TMT)
• Ugandan shilling (UGX)
• Ukrainian hryvnia (UAH)
• United Arab Emirates dirham (AED)
• United States dollar (USD)
• Uruguayan peso (UYU)
• Uzbekistan som (UZS)
• Vanuatu vatu (VUV)
• Venezuelan bolívar (VEF)
• Vietnamese dong (VND)
• Yemeni rial (YER)
• Zambian kwacha (ZMW)
• Zimbabwe dollar (ZWD)

Integration

We offer this payment methods for the following integration modes. Learn in our dedicated guides about the individual differences

• Hosted Checkout Page
• Mobile/Client Integration

Find a high level overview in the "Process flows" chapter.

Depending on the integration mode, differences apply:

• Hosted Checkout Page
• Mobile/Client Integration

Hosted Checkout Page

Add the following properties to a standard CreateHostedCheckout request:

{
   "order":{
      "amountOfMoney":{
         "currencyCode":"EUR",
         "amount":1000
      }
   },
   "hostedCheckoutSpecificInput":{
      "locale":"en_GB",
      "returnUrl":"https://yourReturnUrl.com"
   },
   "mobilePaymentMethodSpecificInput":{
      "authorizationMode":"FINAL_AUTHORIZATION",
      "paymentProductId":302
   }
}

Mobile/Client Integration

Depending on the decryption mode, differences apply:

• We handle decryption
• You handle decryption

We handle decryption

This mode outsources the complexity of the payment data decryption to our platform. Make sure to create certificates and upload them as described in the dedicated chapter. 

Add the following properties to a standard CreatePayment request when sending the decrypted data to our platform:

{
    "mobilePaymentMethodSpecificInput": {
        "encryptedPaymentData": "xxx",
        "paymentProductId": 302,
        "authorizationMode": "FINAL_AUTHORIZATION",
        "ephemeralKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEYcF+GXB1DjbKLn5PgxVky2QTk53HjfoIXOvE7kH6+lixJKSTv1AuPlAUsBD2Nu2qHFwP50Abeh1onwvmvMYY/g==",
        "publicKeyHash": "uUhU0fJoEJNk11gR8Ptd5Uw+jAnudz24rC2EuVcrZhM="
    },
    "order": {
        "amountOfMoney": {
            "amount": 3000,
            "currencyCode": "EUR"
        }
    }
}

You handle decryption

This mode requires you to decrypt the payment data by yourself and send it to our platform. This might have an impact on your PCI compliance type. Contact your acquirer for more information. 

You also need to write the code for this solution by yourself. However, you can use our SDKs in two instances:

1. iOS SDK: Adding the Apple Pay button to your app that opens the Apple Pay payment sheet. Read the Apple tutorial for more information.
2. Server SDKs: Sending the decrypted payment data to our platform.

Make sure to create the certificates and upload them on your server as described in the dedicated chapter. 

Add the following properties to a standard CreatePayment request when sending the decrypted data to our platform:

{
    "mobilePaymentMethodSpecificInput": {
        "decryptedPaymentData": {
            "dpan": "4761120010000492",
            "cryptogram": "jiSRYgf6G2rjYwAAC0GPAHQAAAA=",
            "expiryDate": "1225",
            "cardholderName": "John Doe",
            "eci": "7"
        },
        "paymentProductId": 302,
        "authorizationMode": "FINAL_AUTHORIZATION"
    },
    "order": {
        "amountOfMoney": {
            "amount": 3000,
            "currencyCode": "EUR"
        }
    }
}

Map PKPayment properties to mobilePaymentMethodSpecificInput

After decrypting the payment token on your e-commerce server, you need to send this data via a CreatePayment request. As you cannot use our iOS SDK to create an encrypted blob, you need to pass this data via mobilePaymentMethodSpecificInput.decryptedPaymentData. This table shows how PKPayment maps to mobilePaymentMethodSpecificInput.decryptedPaymentData.

Depending on the individual request, PKPayment may contain further order information. Apply the following mapping to include them in your CreatePayment request:

Process flows

Depending on the integration mode and the decryption mode, differences apply:

• Hosted Checkout Page
• Mobile/Client Integration
  • We handle decryption
  • You handle decryption

Hosted Checkout Page

Make sure to register your Merchant ID as described here.

1. Your customers finalise an order in your shop and select Apple Pay.
2. You send this CreateHostedCheckout request to our platform.
3. You redirect your customers via the redirectUrl to the Apple Pay payment sheet. Your customers confirm the payment.
4. Our platform receives encrypted payment data from Apple.
5. Our platform decrypts the payment data and sends it to your acquirer to process the payment.
6. We receive the transaction result.
7. You redirect your customers to your redirectUrl.
8. You request the transaction result from our platform via GetHostedCheckout or receive the result via webhooks.
9. If the transaction was successful, you can deliver the goods/services.

Mobile/Client Integration

Depending on whether you leave handling payment data decryption to us or do this by yourself, differences apply:

We handle decryption

Make sure to create Apple certificates as described here.

1. Your customers finalise an order in your app and select Apple Pay.
2. Your app sends the order request to your e-commerce server and opens the payment sheet.
3. Your customers confirm the payment in the app.
4. You send the encrypted payment data in property mobilePaymentMethodSpecificInput.encryptedPaymentdata via this CreatePayment request to our platform.
5. Our platform decrypts the payment data and sends them to Apple.
6. Our platform receives encrypted payment data from Apple.
7. Our platform decrypts the payment data and sends it to your acquirer to process the payment.
8. We receive the transaction result.
9. You request the transaction result from our platform via GetPaymentDetails or receive the result via webhooks.
10. Your app displays the transaction result.
11. If the transaction was successful, you can deliver the goods/services.

You handle decryption 

Make sure to create Apple certificates and configure your Worldline/Apple developer account as described here.

1. Your customers finalise an order in your app and select Apple Pay.
2. Your app sends the order request to your e-commerce server and opens the payment sheet.
3. Your customers confirm the payment in the app.
4. Your e-commerce server receives the encrypted data from Apple.
5. Your e-commerce server decrypts the data.
6. You send the decrypted payment data in properties
   mobilePaymentMethodSpecificInput.decryptedPaymentData
   mobilePaymentMethodSpecificInput.publicKeyHash
   mobilePaymentMethodSpecificInput.ephemeralKey
   via this CreatePayment request to our platform.
7. Our platform sends the decrypted payment data to your acquirer to process the payment.
8. We receive the transaction result.
9. You request the transaction result from our platform via GetPaymentDetails or receive the result via webhooks.
10. Your app displays the transaction result.
11. If the transaction was successful, you can deliver the goods/services.

Testing

Refer to our Test cases for test data and detailed instructions.

Additional information

Offering this payment method requires you to either register your Merchant ID (for Hosted Checkout Page integration mode) and/or created your Apple Pay certificates (for Mobile/Client Integration)

Register Merchant ID (Hosted Checkout Page)

Follow these steps:

1. Log in to the Back Office. Go to Configuration > Payment Methods > Apple Pay > Hosted Checkout registration.
2. Read the Apple Pay terms and conditions by clicking on the respective link. Click on "REGISTER" to approve them.
3. Click on "CHECK ACCOUNT STATUS" and wait for the message "Your PSPID is correctly registered" to appear. This will take only a couple of seconds: You are ready to offer Apple Pay to your customers via Hosted Checkout Page integration mode.

Mind the following: 

• You can repeat step 3 anytime to check your status.
• You can revoke your approval any time by clicking on "UNSUBSCRIBE".
• If you reject the Apple Pay terms & conditions, the payment method will not be available on our Hosted Checkout Page.
• Apple's terms and conditions can change. Keep yourself up to date by accessing them regularly.

Create Apple Pay certificates (Mobile/Client integration)

For payments via Mobile/Client Integration, you need to create Apple certificates. Depending on whether you leave handling payment data decryption to us or do this by yourself, differences apply:

We handle decryption

This requires you to create certificates and upload them in the Back Office. To do so, follow these steps:

1. Log in to the Back Office. Go to Configuration > Payment Methods > Apple Pay > Add new certificate.
2. Follow the instructions on the page to
   a) Download the certificate signing request (CSR) on that page.
   b) Create the Apple Pay certificate on the Apple developer portal using that CSR.
   c) Upload the generated certificate via the Browse.../UPLOAD CERTIFICATE buttons.

Find detailed information about how to apply this decryption mode in the “Integration” and “Process flows" chapters.

Mind the following: 

• Make sure to create separate certificates for our test / production environment.
• Apple allows you to create a maximum of three certificates per Merchant ID. Mind that only one certificate per Merchant ID can be active. Use the three slots to manage expiring certificates.
• Due to this limitation, we recommend using different Merchant ID for our test / production environment.
• Apple certificates expire after two years. Make sure to timely create and upload a new one. We will notify you via e-mail as soon as a certificate is about to expire.

You handle decryption

This requires you to create certificates and upload them on your server. To do so, follow these steps:

1. Contact us to set up your Worldline account to allow handling decryption by yourself.
2. Set up your Apple Developer account to allow handling Apple Pay token by yourself.
3. Create the Apple Pay certificates on the Apple developer portal
   a) Create a Certificate signing request
   b) Create a Merchant Identity Certificate
   c) Create a payment processing Certificate
4. Write the code for your app for data decryption.

Find detailed information about how to apply this decryption mode in the “Integration” and “Process flows" chapters.

This decryption mode requires more effort on your side, most notably

• Decrypting the Apple Pay payment token.
• Generating of public keys.
• Creating certificate signing requests (CSRs).

We recommend implementing it only if you

• Prefer handling data encryption yourself.
• Want to access the payment token before processing the actual payment.