Test Apple Pay on iOS devices

Learn how to test use cases around Apple Pay on iOS devices with Selenium on BrowserStack Automate

IMPORTANT

This feature is currently a Private Beta service and available only under Desktop and Mobile Pro, and Enterprise Pro plans. Contact our Support team or Sales team to enable this feature. For more details, check out our pricing page.
Setting this feature will lead to an increase in session start-time by 100-180 seconds. Thus, users are expected to use this feature based on their needs.

The Apple Pay feature in iOS devices enables purchases, one-click payments, and provides additional security for financial transactions. BrowserStack Automate enables you to test Apple Pay on remote iOS devices.

In this guide you will learn about:

Supported devices
Setting the Apple Pay capability
Using JavaScript executor to confirm the payment
Limitations with Apple Pay

Supported devices

Supported Devices	iOS Version
iPhone 15	17
iPhone 14	16
iPhone 14 Pro	16
iPhone 13 Pro Max	15
iPhone 13 Pro	15
iPhone 13 Mini	15
iPhone 13	15
iPhone 11 Pro	15
iPhone 11	15
iPhone XR	15

Set the Apple Pay capability

Use the capability values enableApplePay for W3C protocol and browserstack.enableApplePay for JSON wire protocol in your test scripts.

BrowserStack SDK
Legacy Integration

If you are using BrowserStack SDK, you can set the following capability within the browserstack.yml file:

Capability	Description
`enableApplePay`	Set this capability to `"true"` if you want to use Apple Pay in the test.
`nativeWebTap`	Set this capability to `"true"` if you are unable to get Apple Pay payment screen after clicking the Apple Pay button.

Copy

BrowserStack SDK is a plug-n-play solution that takes care of all the integration steps for you. Using the BrowserStack SDK is the recommended integration method for your project. To know more, visit the SDK core concepts page.

Selenium W3C
Selenium Legacy JSON

  
      Capability
      Description
    
      enableApplePay
      Set this capability to "true" if you want to use Apple Pay in the test.
    
      nativeWebTap
      Set this capability to "true" if you are unable to get Apple Pay payment screen after clicking the Apple Pay button.

  
      Capability
      Description
    
      browserstack.enableApplePay
      Set this capability to "true" if you want to use Apple Pay in the test.
    
      browserstack.nativeWebTap
      Set this capability to "true" if you are unable to get Apple Pay payment screen after clicking the Apple Pay button.

Capability	Description
`browserstack.enableApplePay`	Set this capability to `"true"` if you want to use Apple Pay in the test.
`browserstack.nativeWebTap`	Set this capability to `"true"` if you are unable to get Apple Pay payment screen after clicking the Apple Pay button.

Example:

Selenium W3C
Selenium Legacy JSON

      Java
    

      Node.js
    

      C#
    

      Python
    

      Ruby
    
//Java example
DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("osVersion", "16");
browserstackOptions.put("deviceName", "iPhone 14");
browserstackOptions.put("enableApplePay", "true");
browserstackOptions.put("nativeWebTap", "true");
capabilities.setCapability("bstack:options", browserstackOptions);
var capabilities = {
	'bstack:options' : {
		"osVersion" : "16",
		"deviceName" : "iPhone 14",
		"enableApplePay" : "true",
		"nativeWebTap" : "true",
	}
}
SafariOptions capabilities = new SafariOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("osVersion", "16");
browserstackOptions.Add("deviceName", "iPhone 14");
browserstackOptions.Add("enableApplePay", "true");
browserstackOptions.Add("nativeWebTap", "true");
capabilities.AddAdditionalOption("bstack:options", browserstackOptions);
desired_cap = {
    'bstack:options' : {
        "osVersion" : "16",
        "deviceName" : "iPhone 14",
        "enableApplePay" : "true",
        "nativeWebTap" : "true",
    },
}
capabilities = {
	'bstack:options' => {
		"osVersion" => "16",
		"deviceName" => "iPhone 14",
		"enableApplePay" => "true",
		"nativeWebTap" => "true",
	},
}

      Java
    

      Node.js
    

      C#
    

      Python
    

      Ruby
    
DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
caps.setCapability("os_version", "16");
caps.setCapability("device", "iPhone 14");
desiredCapabilities.setCapability("browserstack.enableApplePay","true");
desiredCapabilities.setCapability("browserstack.nativeWebTap","true");
var capabilities = {
    "os_version" : "16",
    "device" : "iPhone 14",
    "browserstack.enableApplePay" : "true",
    "browserstack.nativeWebTap" : "true",
}
SafariOptions capability = new SafariOptions();
capability.AddAdditionalCapability("os_version", "16");
capability.AddAdditionalCapability("device", "iPhone 14");
capability.AddAdditionalCapability("browserstack.enableApplePay", "true");
capability.AddAdditionalCapability("browserstack.nativeWebTap", "true");
desired_cap = {
    "os_version" : "16",
    "device" : "iPhone 14",
    "browserstack.enableApplePay" : "true"
    "browserstack.nativeWebTap" : "true"
}
caps = Selenium::WebDriver::Remote::Capabilities.new
caps["os_version"] = "16"
caps["device"] = "iPhone 14"
caps["browserstack.enableApplePay"] = "true"
caps["browserstack.nativeWebTap"] = "true"

Apple Pay test flow

Your test script must be modified with these custom executors along with the logic to select the UI elements in the webapp that triggers the Apple Pay payment, in the following order.

Trigger the payment workflow that uses Apple Pay as the payment method using your framework specific commands.

Unable to get Apple Pay payment screen after clicking Apple Pay button?

To resolve this issue, perform any one of the following:

Set the appium:nativeWebTap capability to true.

Or, before you click the Apple Pay button, switch to native context using the following code snippet, and wait for a few seconds for the popup to appear.

await browser.url("https://applepaydemo.apple.com/");
  await browser.waitUntil(
    async () => (await browser.getTitle()).match(/Apple/i),
    15000,
    "Title didn't match"
  );
  await driver.switchContext("NATIVE_APP");
  const button = await $('[name="Apple Pay"]');
  await button.click();

If there are no context switching methods for the language or framework you are using, refer to the following Appium documentation: Set Current Context or The Context API.

Once you complete any one of the above, run the BrowserStack executor for Apple Pay.

If you want to add Apple Pay details such as shipping, billing, or contact information, use the following JavaScript executor with the applePayDetails action.

For the Apple Pay details, ensure the details meet the following conditions:

In your shipping and billing addresses, only include parameters that apply to the addresses and remove the parameters that are not applicable. For example, if your test address doesn’t have a value for the province parameter, remove the parameter from the script.
For the geographical codes in your shipping and billing addresses, use only one of these parameters based on what your address requires and the device accepts: postalCode, postCode, zip. In the following code snippet, we have used postalCode.
The phone number must have the country code prefix with the + character. For example, use this +1-212-456-7890 or +12124567890.

Your session might fail if your test addresses don’t have the fields that the device requires. For example, if your test addresses have the zip parameter, but the device requires a different geographical code parameter, the session will fail. In this case, you can re-run the script with either postalCode or postCode and see which geographical code parameter the device accepts.

driver.executeScript("browserstack_executor: {\"action\":\"applePayDetails\", 
\"arguments\": {
  \"shippingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"billingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"contact\" : {
      \"email\" : \"user input\",
      \"phone\" : \"user input\"
     }
  }
}”);

await driver.executeScript("browserstack_executor: {\"action\":\"applePayDetails\", 
\"arguments\": {
  \"shippingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"billingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"contact\" : {
      \"email\" : \"user input\",
      \"phone\" : \"user input\"
     }
  } }”)

((IJavaScriptExecutor)driver).ExecuteScript("browserstack_executor: {\"action\":\"applePayDetails\", 
\"arguments\": {
  \"shippingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"billingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"contact\" : {
      \"email\" : \"user input\",
      \"phone\" : \"user input\"
     }
  }
}”);

driver.execute_script("browserstack_executor: {\"action\":\"applePayDetails\", 
\"arguments\": {
  \"shippingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"billingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"contact\" : {
      \"email\" : \"user input\",
      \"phone\" : \"user input\"
     }
  } }”)

driver.execute_script("browserstack_executor: {\"action\":\"applePayDetails\", 
\"arguments\": {
  \"shippingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"billingDetails\" : {
      \"firstName\" : \"user input\",
      \"lastName\" : \"user input\",
      \"street\" : \"user input\",
      \"addressLine2\" : \"user input\",
      \"city\" : \"user input\",
      \"state\" : \"user input\",
      \"zip\" : \"user input\",
      \"province\" : \"user input\",
      \"islandName\" : \"user input\",
      \"country\" : \"user input\"
      },
  \"contact\" : {
      \"email\" : \"user input\",
      \"phone\" : \"user input\"
     }
  }}”)

After initiating the payment flow from your automation, use the following Javascript executor to confirm the transaction.

driver.executeScript("browserstack_executor: {\"action\":\"applePay\", 
\"arguments\": {
  \"confirmPayment\" : \"true\"
  }
}”);

await driver.executeScript("browserstack_executor: {\"action\":\"applePay\", \"arguments\": { \"confirmPayment\" : \"true\"} }”)

((IJavaScriptExecutor)driver).ExecuteScript("browserstack_executor: {\"action\":\"applePay\", 
\"arguments\": {
  \"confirmPayment\" : \"true\"
  }
}”);

driver.execute_script("browserstack_executor: {\"action\":\"applePay\", \"arguments\": { \"confirmPayment\" : \"true\"} }”)

driver.execute_script("browserstack_executor: {\"action\:"\"applePay\", \"arguments\": { \"confirmPayment\" : \"true\"}}”)

Enter the passcode 123456 to complete the payment.

The following is an example in the Java language:

  driver.getKeyboard().sendKeys("123456");

Example

The following code snippet is an end-to-end example for testing Apple Pay in Ruby langauge:

require 'rubygems'
require 'selenium-webdriver'

username = "username_name"
access_key = "access_key"
url = "https://#{username}:#{access_key}@hub.browserstack.com/wd/hub"

def run_session(bstack_options, url)
 options = Selenium::WebDriver::Options.send "chrome"
 options.browser_name = bstack_options["browserName"].downcase
 options.add_option('bstack:options', bstack_options)
 driver = Selenium::WebDriver.for(:remote,
   :url => url,
   :capabilities => options)
 begin
    driver.navigate.to "https://applepaydemo.apple.com"
    driver.execute_script(
        'browserstack_executor: {
            "action": "applePayDetails",
            "arguments": {
                "billingDetails": {
                    "firstName": "Some",
                    "lastName": "User",
                    "state": "Some State",
                    "city": "Some City",
                    "street": "Some Street",
                    "postCode": "Some Post Code",
                    "country": "Some Country"
                },
                "shippingDetails": {
                    "firstName": "Some",
                    "lastName": "User",
                    "state": "Some State",
                    "city": "Some City",
                    "street": "Some Street",
                    "postCode": "Some Post Code",
                    "country": "Some Country"
                },
                "contact": {
                    "email": "someemail@gmail.com",
                    "phone": "+11234567890"
                }
            }
        }'
    )
 rescue
     driver.execute_script('browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"failed", "reason": "Some elements failed to load"}}')
 end
 driver.quit
end
BUILD_NAME = "Apple Pay Build"
caps = {
    "deviceName" => "iPhone 15",
    "osVersion" => "17",
    "browserName" => "safari",
    "deviceOrientation" => "portrait",
    "buildName" => BUILD_NAME,
    "enableApplePay" => true,
    "sessionName" => "Apple Pay Test",
    "interactiveDebugging" => true,
    "idleTimeout" => 300
}
run_session(caps, url)

Copy

Limitations with Apple Pay

On BrowserStack remote iOS devices, testing with Apple Pay is limited to the following regions:

Geography	Country
North America	United States, Canada
Europe	France, Ireland, Italy, Spain, United Kingdom, Germany
Asia	China Mainland, Hong Kong, Taiwan, Japan, Russia, Singapore
Australia	Australia, New Zealand

Check this page for a list of various JavaScript Executors that BrowserStack offers.

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!

Test Apple Pay on iOS devices

Supported devices

Set the Apple Pay capability

Apple Pay test flow

Unable to get Apple Pay payment screen after clicking Apple Pay button?

Example

Limitations with Apple Pay

Related topics

We're sorry to hear that. Please share your feedback so we can do better

We're continuously improving our docs. We'd love to know what you liked

We're sorry to hear that. Please share your feedback so we can do better

We're continuously improving our docs. We'd love to know what you liked