Accept Apple Pay

Accept Apple Pay payments in your online store.

Apple Pay allows your customers to make payments in your app or website using Touch ID or Face ID to authenticate a credit or debit card added to their Apple Pay account. Use the emerchantpay Apple Pay API to accept Apple Pay as a payment method across all of emerchantpay’s payment integrations.

Integration options

Choose how you want to integrate Apple Pay:

Integration Method	Details
emerchantpay Payment Gateway API	Use the Apple Pay API for full control over the integration. Ideal for custom-built payment flows emerchantpay Payment Gateway SDK libraries with code samples available in multiple languages Requires knowledge of HTTP, XML/JSON, and UTF-8
Web Payment Form (WPF)	A simpler solution with minimal development effort. Hosted form with built-in Apple Pay support Minimal coding required Contact your Account Manager to enable Apple Pay via the WPF Refer to the emerchantpay Payment Gateway API WPF documentation for setup

Prerequisites

Your Apple Pay setup requirements depend on your integration type.

Web Payment Form (WPF)

For WPF integrations, the Apple Pay button is displayed on emerchantpay’s hosted payment page. You don’t need to create an Apple Developer account or generate and upload a .p12 file because emerchantpay manages the Apple Pay configuration.

To enable Apple Pay on WPF, contact your Account Manager or emerchantpay support.

Server-to-server

If you integrate Apple Pay and display the Apple Pay button on your own website or payment page, you are responsible for completing the Apple Pay setup required for your domain.

You need:

An Apple Developer account with the Team Agent or Admin role. See Configuring Your Environment.
A valid .p12 file uploaded to the Gateway Console as shown below:

Generate a .p12 file for Apple Pay.
Open the Gateway Console.
Select Configuration > Merchants in the navigation menu on the left.
Click the Name of the merchant account or select Actions > View details.
Under Apple Pay Onboarding, click Payment Processing Certificates to show that section.
Click Browse and select the generated .p12 file.
Click Upload certificate.

Warning: Processing certificates have a validity of one year. Generate and upload a new certificate regularly to ensure your Apple Pay payments are processed.

1. Authorise an Apple Pay payment

After your customer selects Apple Pay at checkout, the Apple Pay API will return an encrypted payment token containing the unique transaction information.

To integrate an Apple Pay button and authorise Apple Pay payments on your site, see the Apple implementation guidelines for app and web.

Example of a unique payment token:

{
  “token”: {
    “paymentData”: { … },
    “paymentMethod”: { … },
    “transactionIdentifier”: “32b…4f3”
  },
  “billingContact”: { … },
  “shippingContact”: { … }
}

2. Create an Apple Pay payment request

After the payment token is received, create an Apple Pay payment request to the emerchantpay payment gateway. Specify the encrypted payment token in payment_token and the payment type in payment_subtype.

Accepted Apple Pay payment types:

sale
authorize
init_recurring_sale

See the emerchantpay Payment Gateway API Apple Pay documentation for the complete list of Apple Pay parameters and code samples.

Example of passing an Apple Pay transaction request that contains a unique payment token:

  <?xml version=”1.0″ encoding=”UTF-8″?>
  <payment_transaction>
    <transaction_type>apple_pay</transaction_type>
    <transaction_id>119643250547501c79d8295</transaction_id>
    <payment_subtype>authorize</payment_subtype>
    <payment_token>
      {
        “paymentData”: { … },
        “paymentMethod”: { … },
        “transactionIdentifier”: “32B…4F3”
      }
    </payment_token>

Use your staging environment credentials to initially set up and test your integration. Once you are ready to move to production and accept live payments, create a payment request using your production credentials and production URLs.

3. Receive a response

You will receive a Success or Error response to your payment request.

Example of a Success response:

  <?xml version=”1.0″ encoding=”UTF-8″?>
  <payment_response>
    <transaction_type>apple_pay</transaction_type>
    <status>approved</status>
    <mode>live</mode>
    <transaction_id>119643250547501c79d8295</transaction_id>
    <unique_id>44177a21403427eb96664a6d7e5d5d48</unique_id>
    <consumer_id>123456</consumer_id>
    <avs_response_code>5I</avs_response_code>
    <avs_response_text>Response provided by issuer processor; Address information not verified</avs_response_text>
    <authorization_code>345678</authorization_code>
    <response_code>00</response_code>
    <timestamp>2022-06-29T15:36:44Z</timestamp>
    <descriptor>Acme Co.</descriptor>
    <amount>100</amount>
    <currency>USD</currency>
    <sent_to_acquirer>true</sent_to_acquirer>
    <scheme_transaction_identifier>019091214161031</scheme_transaction_identifier>
  </payment_response>

Depending on the payment type you specified in the payment_subtype, you can capture and settle the customer transaction. See the emerchantpay Payment Gateway API Transaction documentation for more information.

4. Test your integration

Use the Apple Pay sandbox to test your Apple Pay integration:

Add an item to your cart in your online store.
Proceed to the checkout page and check out using the Apple Pay button.
Pay using one of the Apple test card details.
Log in to the Gateway Console.
In the navigation menu, go to Payment transactions.
Verify that the transaction appears at the top of the list and is successful.

5. Accept live payments

After you have successfully tested your Apple Pay integration, you are ready to move to the production environment and accept live payments. Contact your emerchantpay Account Manager to get your login credentials for the production environment.

To move to the production environment, create payment requests using your production API credentials and production URLs.

You are now ready to accept live payments using Apple Pay.

Was this page helpful?