Apple Pay
Intro
123
Apple Pay is Apple’s mobile payment product, which allows consumers an easy and secure way to pay for physical goods and services such as groceries, clothing, tickets and reservations in your iOS apps. By using Touch ID, users can quickly and securely provide their payment.
The consumer adds her/his credit or debit cards to their wallet on their iPhone and adds the payment and shipping information to the Apple Pay wallet. The payment details the consumer enters in the Apple Pay wallet are tokenized and then securely stored. If the consumer clicks the “Buy with Apple Pay” button in the app, the payment can immediately start, since the card with which the consumers wants to pay will be loaded from the Apple Pay wallet.
Our iOS SDK allows you to easily add Apple Pay to your mobile app. We will manage the decryption of the payment data for you. If you want to, you can also choose to decrypt the data yourself and send it over to us to process the payment.
Your customers can use cards from the following brands:
Key benefits
- A frictionless consumer experience using Apple’s native Touch ID
- Easy integration for developers using our iOS SDK
- A secure way of paying as the card data of the consumer is tokenized and the Device PAN (DPAN) is used to process the payment.
- Increase your conversion for in-app payments
- Huge potential in terms of usage, due to the millions of users on iOS devices.
Boarding
To accept payments for this payment method regardless of the integration mode, make sure you have an acquisition contract with one of the supported acquirers. We will clarify this with you during the onboarding process.
Depending on the integration mode, further requirements are applicable:
- Hosted Checkout Page: Accept Apple's terms and conditions as described in the dedicated chapter. This will allow you to register your Apple Merchant ID and to offer Apple Pay on our secure payment page
- Mobile/Client Integration: Get an active Apple developer account and a subscription to the iOS developer program. This will allow you to create your Apple Pay certificates as described in the dedicated chapter
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)
Integration
To make this payment method appear on our Page de paiement hébergée as a selectable payment method, your customers need to
- Be located in one of the supported countries
- Own at least one of the supported cards in their Apple Pay wallet:
- Browse with Safari
- Use one of the following devices:
iPhones with Face ID and/or Touch ID (except iPhones 5S)
iPad Pro, iPad Air, iPad, and iPad mini models with Touch ID or Face ID
Apple Watch Series 1 and 2 and later, Apple Watch (1st generation)
Mac models with Touch ID, or Mac models introduced in 2012 or later with an Apple Pay-enabled iPhone or Apple Watch
Make also sure to register your Merchant ID as described in the dedicated chapter
We offer this payment methods for the following integration modes. Learn in our dedicated guides about the individual differences
Find a high level overview in the "Process flows" chapter.
Depending on the integration mode, differences apply:
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
}
}| Properties | Remarks |
|---|---|
|
order.amountOfMoney |
amount: The gross amount you want to charge for this order |
|
hostedCheckoutSpecificInput |
locale: The language version of our Hosted Checkout Page and the Apple Pay payment sheet returnUrl: The URL we redirect your customers to after the payment has been finalised |
|
mobilePaymentMethodSpecificInput |
authorizationMode: Set to either "FINAL_AUTHORIZATION"/"SALE" depending on whether you want to process payments in authorisation/direct sale mode paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" chapter. It instructs our platform to send your customers directly to the Apple Pay payment sheet. If left out, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method in your account |
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI
Find detailed information about this object and its properties in our CreatePaymentAPI
Find detailed information about this object and its properties in our CreatePaymentAPI
Process flows
Depending on the integration mode and the decryption mode, differences apply:
- Hosted Checkout Page
- Mobile/Client Integration
Hosted Checkout Page
Make sure to register your Merchant ID as described here.
- Your customers finalise an order in your shop and select Apple Pay
- You send this CreateHostedCheckout request to our platform
- You redirect your customers via the redirectUrl to the Apple Pay payment sheet. Your customers confirm the payment
- Our platform receives encrypted payment data from Apple
- Our platform decrypts the payment data and sends it to your acquirer to process the payment
- We receive the transaction result
- You redirect your customers to your redirectUrl
- You request the transaction result from our platform via GetPayment or receive the result via webhooks
- 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.
- Your customers finalise an order in your app and select Apple Pay
- Your app sends the order request to your e-commerce server and opens the payment sheet
- Your customers confirm the payment in the app
- You send the encrypted payment data in property mobilePaymentMethodSpecificInput.encryptedPaymentdata via this CreatePayment request to our platform
- Our platform decrypts the payment data and sends them to Apple
- Our platform receives encrypted payment data from Apple
- Our platform decrypts the payment data and sends it to your acquirer to process the payment
- We receive the transaction result
- You request the transaction result from our platform via GetPayment or receive the result via webhooks
- Your app displays the transaction result
- 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.
- Your customers finalise an order in your app and select Apple Pay
- Your app sends the order request to your e-commerce server and opens the payment sheet
- Your customers confirm the payment in the app
- Your e-commerce server receives the encrypted data from Apple
- Your e-commerce server decrypts the data
- You send the decrypted payment data in properties
mobilePaymentMethodSpecificInput.decryptedPaymentData
mobilePaymentMethodSpecificInput.publicKeyHash
mobilePaymentMethodSpecificInput.ephemeralKey
via this CreatePayment request to our platform - Our platform sends the decrypted payment data to your acquirer to process the payment
- We receive the transaction result
- You request the transaction result from our platform via GetPayment or receive the result via webhooks
- Your app displays the transaction result
- If the transaction was successful, you can deliver the goods/services
Testing
Refer to our Test cases for test data and detailed instructions
Make sure to use the right endpoint and switch back to the live URL as soon as you have finished your tests