Apple Pay / Google Pay
Apple Pay and Google Pay are available as payment options during Checkout, but require some configuration from the software platform to make them available to merchants. This guide covers the setup process.
Requirements
- Your implementation must use
shuttle-1.3.3.jsor later shuttle.jsmust be loaded in the topmost frame of the browser. Wallet buttons will not appear if Checkout is embedded in an iframe.- Domains where Checkout will be hosted must be pre-registered for wallet buttons to appear
Limitations
Apple Pay and Google Pay currently support one-time payments only. Wallet buttons will not appear when tokenizing a card or saving a card as part of a payment.
Domain Registration
When creating or updating an instance via the API, pass any domains where checkout will be hosted in the checkout_urls string array.
For example:
merchant.commerchant.platform.com
To check domain registration status, query the instance object via the API. It includes which domains were successfully registered and which failed.
Enabling Apple Pay / Google Pay
Apple Pay and Google Pay must be enabled on your application before wallet buttons will appear for your merchants.
Ensure you have completed Domain Registration (above) by passing
checkout_urlsfor each merchant instance. Enabling Apple Pay or Google Pay without registered domains will have no effect.
To enable these payment methods:
- Go to the Developer Portal
- Navigate to the Developer tab of your application
- Select Configure Onboarding
- Enable Apple Pay and/or Google Pay for sandbox and/or live environments
You can control availability separately for sandbox and live environments.
Apple Pay
Apple Pay is available for Safari and iOS users.
Domain Verification
Apple require the domain hosting Checkout to be verified. This involves hosting a verification file at:
https://yourdomain/.well-known/apple-developer-merchantid-domain-association
Host the Shuttle verification file at this URL:
apple-developer-merchantid-domain-association.txt
Requirements:
- The endpoint must be publicly accessible
- Return the content with mimetype
text/plain
Google Pay
Google Pay is available across browsers and Android devices.
Domain registration via checkout_urls (as described above) is required for Google Pay buttons to appear.
Enabling Apple Pay / Google Pay for a Merchant
For a merchant to use Apple Pay or Google Pay, at least one of their connected payment processors must support network tokens. Shuttle maintains its own Apple Pay and Google Pay integrations and generates network tokens from wallet transactions, which are then processed via the processor's network token rails.
To configure Apple Pay / Google Pay for a merchant:
- In Configure Checkout, if any of the merchant's connected gateways support network tokens, a Network Tokens toggle will be available
- Enable the toggle to reveal Apple Pay and Google Pay options under Customize Checkout
- If the merchant is connected to multiple processors that support network tokens, they can select which processor to use for Apple Pay and Google Pay transactions
- Optionally configure rules such as minimum/maximum transaction amounts or available currencies
- Enter the Merchant Legal Name - this is the name displayed to customers in the Apple Pay or Google Pay payment sheet
- Save the changes
Sandbox Testing
Real payments cannot be processed through Apple Pay or Google Pay in sandbox environments. Each wallet has specific requirements for testing.
Apple Pay
Testing Apple Pay requires a physical Apple device (iPhone, iPad, or Apple Watch) with Developer Mode enabled. You cannot test Apple Pay in a simulator or on a non-Apple device.
To set up sandbox testing:
- Enable Developer Mode on your test device
- Set the device region to a country that supports Apple Pay
- Sign out of your Apple Account and sign in with a sandbox tester account
- Add Apple's test cards to your Wallet manually
- When prompted for OTP verification, use
111111
Google Pay
Testing Google Pay is more straightforward. You need an Android device with Chrome 59+ and Google Play services 16.0.0+, or you can test in a desktop browser.
To set up sandbox testing:
- Ensure you have at least one card or PayPal account stored in Google Pay or your Google account
- Join the Google FPAN test card suite group to access test cards
- Wallet buttons will appear when testing against your Shuttle sandbox environment
Updated 6 days ago