Skip to content
Customer portal
Contact us
  • There are no suggestions because the search field is empty.

Apple Pay with MPGS Gateway 

Apple Pay is a digital wallet service by Apple Inc. that allows merchants to make payments in person, in iOS apps, and on the web using Safari. This service is supported on the iPhone, iPad, and Mac. It is positioned as an alternative to traditional credit and debit cards. Paydock supports payment flows where it acts as a token decryptor before sending the transaction to MPGS for processing.

Prerequisites

Before starting the integration, complete the following setup steps:

  1. Create a Mastercard Merchant Account. You will need a merchant account with Mastercard to connect it to Paydock. Sign Up process here.
  2. Create an Apple Developer Account. An Apple Developer Account is required to integrate Apple Pay. Please follow the instructions in this article
  3. Obtain your Mastercard Credentials.Your Merchant ID and API password can be found in your Mastercard Merchant Administration account.
    1. Log into the
    2. Mastercard Merchant Administration
    3. Go to
    4. Admin > Integration Settings.
    5. Generate a password in the
    6.  Integration Authentication section.

       

     4.  Configure your Apple Pay Account.You will need to set up the following in your  developer            account:
    1. Merchant ID: This uniquely identifies you to Apple Pay.
    2. Payment Processing Certificate: This is used to secure transaction data by encrypting i
    3. Merchant Identity Certificate: This TLS certificate is used to authenticate your sessions with Apple Pay servers

Configuring Integration in the Paydock account

Step 1: Connect MPGS in Paydock

Begin by connecting the MPGS gateway in the Paydock dashboard and enabling Apple Pay functionality. Complete the following required fields:

  • Label:A name for your reference to recognise the service.
  • Merchant: Your MasterCard Merchant ID.
  • Password: Your MasterCard API password.
  • Enable Wallet Payments.
  • Enable Apple Pay and complete the following fields that appear:

    1. Merchant ID: Your Apple Pay merchant ID

    2. Merchant ID Certificate: The TLS certificate for authenticating sessions with Apple Pay servers.

    3. Merchant ID Private Key: The key associated with the Merchant ID Certificate

    4. Payment Processing Certificate: The certificate used to secure transaction data. 

    5. Payment Processing Private Key: The key associated with the Payment Processing Certificate

  • Environment:Select if you are connecting to a Production or Sandbox environment.

Once all fields are completed, click

Connect.

Step 2: Add "Checkout with Apple Pay" to Your Website
 

The "Checkout with Apple Pay" button can be integrated into the merchant's website using the Client SDK package.

For implementation details, refer to the Wallet Buttons section in the SDK documentation.

Apple Pay Device and Wallet Capability.

This outlines the various states that indicate a user's device support for Apple Pay and the availability of qualifying payment cards within the Wallet application for web payments. These states dictate how a merchant should present the Apple Pay payment option.

Capability Flag Description Merchant Action Recommendation
credentials_available The device fully supports Apple Pay, and the user has at least one active payment card saved in Wallet that qualifies for web payments. Display the Apple Pay button and offer it as the primary payment option.
credentials_status_unknown The device supports Apple Pay, but the status of the user’s saved Wallet credentials cannot be determined. Display the Apple Pay button and offer it as a payment option. The Apple QR code may also be displayed to consumers in this scenario.
credentials_unavailable The device supports Apple Pay, but the user does not have any active payment cards saved in Wallet. The merchant may choose to display the Apple Pay button, allowing the user to set up a card.

apple_pay_capabilities: ['credentials_available','credentials_status_unknown','credentials_unavailable']

Note

For third-party browsers on non-Apple devices, the reported Apple Pay capability status can be leveraged to facilitate payment via QR code. In this scenario, displaying the Apple QR code allows consumers to scan it with an Apple device (like an iPhone) to complete the payment securely through their Wallet.