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.

To integrate with Apple Pay, connect to the emerchantpay Genesis gateway using the emerchantpay Apple Pay API. You should have a working knowledge of web programming languages, HTTP methods in XML and JSON formats, and UTF8 encoding. Use the Genesis SDK libraries with code samples to integrate with the gateway in a range of languages.

For a solution that requires less development overhead, accept Apple Pay payments through the emerchantpay Web Payment Form (WPF). Contact your Account Manager and tell them you want to accept Apple Pay through the WPF, and refer to the WPF API.

Prerequisites

To proceed with this solution, you must have an emerchantpay merchant account. Apply for a merchant account by filling out and submitting this contact form.

You will be assigned an emerchantpay Account Manager, who will provide you with credentials and assist you with any of emerchantpay’s payment solutions.

To use emerchantpay as an Apple Pay payment provider, you must have an Apple Developer Account with the Team Agent or Admin role. See Registering with Apple Pay and Applying to Use the API and Configuring Your Environment to apply for a Developer Account.

Upload your .p12 file

To use Apple Pay in a server-to-server integration or with the emerchantpay Web Payment Form (WPF), you must generate and upload your processing certificate as a .p12 file in the Apple Pay Onboarding section of your Genesis Merchant Console.

Processing certificates have a validity of one year. Generate and upload a new certificate regularly to ensure your Apple Pay payments are processed. For more information on how to generate your .p12 certificate, see Generate a .p12 file for Apple Pay.

Contact support if you do not see the Apple Pay Onboarding section or you need help uploading your .p12 file.

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 a Apple Pay payment request to the emerchantpay Genesis 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 Apple Pay API 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>Descriptor one</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 Transactions API 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 Genesis.
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 Genesis 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.