Apple Pay Deposit - PXP Checkout

ApplePay is a secure, easy way to make payments for physical goods and services within iOS and watchOS. Websites can also accept ApplePay – it is available in Safari for iPhone, iPad, and Mac. Users authorize payments and provide shipping and contact information, using securely stored credentials on an iPhone, an iPad, or a MacBook Pro with Touch ID. On other Macs, the purchase is confirmed with the user's nearby iPhone or Apple Watch that has ApplePay enabled.

The following method ID is covered in this section:

IDNameCredit/Debit State

Payment method interaction type: Synchronous Execution (see Interaction Types)

Redirect Integration

Applepay deposit is now available in the PXP checkout.

In order to initiate a PXP Checkout payment with ApplePay, please pass the following _additionalDetails _fields:

key (value type, account type, required)Description
DomainName (string, optional)This parameter will be configured by PXP in the background. Optionally it can be passed by the merchant.
Description (string, optional)Please enter any description.

The following getRedirectData request will open directly the Applepay iFrame:

<getRedirectDataRequest xmlns="" xmlns:xsi="" xmlns:xsd="">
    <redirectParameters xsi:type="paymentMethodDetailsRedirectParameters">
            <detail xsi:type="keyStringValuePair">
            <detail xsi:type="keyStringValuePair">

Allowed card types and supported networks

The following merchant option settings will be configured by PXP on request from the merchant.

PXP can configure allowed types, either supportsCredit - only credit cards are allowed - or supportsDebit - only debit cards are allowed.

PXP can configure various supported card networks, such as Visa, Mastercard, Discover or Amex, however also depending on the processor of the actual card transaction.

Handling events from ApplePay in the merchants page

The checkout page that contains the ApplePay button sends events that can be used in the hosting page to determine if ApplePay is available for the customer, and about the status of the payment process.

By handling these events, the merchant has full control about the user experience.
If a merchant decides to handle the events, the automatic redirection to success or error page can be configured with the following options:

  • when the payment is finished, redirection in the iFrame to the success or error page sent by the merchant.
  • when the payment is finished, redirection will be done on the hosting page of the iFrame
  • when the payment is finished, no redirection will take place.

The following events are supported:

  1. When the ApplePay image is displayed, the event will be:
    {"eventType":"applepayAvailable", "applepayEnabled":true,"paymentId":"example-151","paymentSuccessful":null,"message":null}
  2. When the ApplePay payment has failed (with processor), the event will be:
    {"eventType": "paymentProcessing", "paymentId":"example-151","paymentSuccessful":false}
  3. When the Applepay payment is successful, the event will be:
    {"eventType": "paymentProcessing", "paymentId":"example-152","paymentSuccessful":true}
  4. When the ApplePay payment has timed out:
    {"eventType":"timeout","applepayEnabled":false,"paymentId":"example-173","paymentSuccessful":false,"message":"The session timed out"}
  5. When the configuration is incorrect (domain name is wrong (if sent)), the following event will be returned:
    {"eventType": "paymentProcessing", "paymentId":"example-152","paymentSuccessful":false, "message": "ApplePaySession canceled."}
  6. When the ApplePay control appears and the user clicks on the "Cancel" button on the top right:
    {"eventType": "paymentProcessing", "paymentId":"example-152","paymentSuccessful":false, "message": "ApplePaySession canceled."}
  7. When the Applepay page is opened in Chrome, a message "ApplePay is not available" is displayed. No event is returned.

Here is an example how to handle ApplePay events:

	function handleApplepayEvents(event) {					
		if(event.origin == '' || event.origin == ''){
			if( == 'applepayAvailable'){				
				if ({
					// The ApplePay button is shown
					// ApplePay can not be used in this browser/device
			else if( == 'paymentProcessing'){								
				if ({
					// The payment was processed successfuly
					// There was an error in the payment processing
					// contains an error message
	window.addEventListener("message", handleApplepayEvents, false);

Testing Guide

Add a test card to the Wallet

  1. Make sure to sign out of iCloud and sign into your test device with your sandbox tester account.
  2. Go to Wallet and tap Add Credit or Debit Card.
  3. Using your test credential, follow the steps to add a new card using manual entry.
  4. After your card has been added, you may begin testing.
  5. When the ApplePay control is displayed, you confirm the payment by touchID or faceID or by password.


Test cards

For test cards, go to
Scroll down to the section "Test cards for Apps and the web"

Only consider the test cards listed on this page.

The merchant does not need to configure a Apple developer account for Applepay. The merchant does not need to register a merchantID, create certificates and verify it´s website domain. The merchant does not need to create a sandbox test account.

Merchants using PXP´s checkout don´t need to do that.


Test data from merchant

Merchants should provide to it´s PXP contact one (or many) device identifiers (UUID) for testing. These are from devices, MacOS device or an iPhone, the merchant will use for testing. These should not be a production device.

Merchants should also provide an eMail address that is not yet associated to an Apple account. The PXP team will then setup both in the Apple sandbox account.

State Diagram

The payment will be initiated with payment method being ApplePayDeposit and will then be changed to e.g. payment method AppleVisaDeposit once the token has been processed.


No notification are sent as long the payment is with payment method ApplePay Deposit. After changing the payment method the notifications are sent according the card payment methods' integration manual. (see Card Payments Notifications)