Apple Pay is a payment provider allowing consumers to pay using their payment methods saved to their Apple Pay account. This section is intended to help you implement Apple Pay based on your preferred integration workflow.

Services and compatibility

Configuration

In order to use Apple Pay with your merchant account, you must first work with integrations to add it to your account.

Then, you must go through the following information and steps.

Prerequisites

In order to configure your account for use with Apple Pay, you need the following:

• An Apple computer

• An Apple Developer account. For more information about the program, see the Apple Developer site.

• Enrollment in the Apple Developer Program as an organization, including a D-U-N-S Number for your legal entity per these enrollment requirements.

  Note: If you are not sure of what a D-U-N-S Number is for your business, you can look it up online or apply for one by following the instructions on the D-U-N-S Number support page.

• A connection (gateway) account

Configuration tasks

After you complete the above prerequisites, you are ready to begin the configuration tasks:

• Create an Apple Pay merchant ID
• Create a payment processing certificate
• Create a merchant identity certificate
• Verify your domain
• Provide your configuration settings to Integrations Support

Note: When integrating Apple Pay to multiple environments, you need to verify the domain for each environment. However, you only need to complete the first three tasks one time.

Create an Apple Pay merchant ID

Follow these steps to create an Apply Pay merchant ID.

1. Go to the Apple Developer portal.
2. Sign in to your account.
3. Select Certificates, IDs & Profiles.
4. Select Identifiers.
5. On the Identifiers screen, click the + (plus sign) button.
6. Click the Merchant ID radio button, then click Create.
7. Fill in the required fields.
8. Copy or note the Merchant ID. You need it when you create the payment processing certificate and the merchant identity certificate.

Create a payment processing certificate

Contact Integrations Support to provision a supported gateway and get a payment processing certificate.

Follow these steps to upload the certificate to Apple Pay.

1. Go to the Apple Developer portal.
2. Sign in to your account.
3. Select Certificates, IDs & Profiles.
4. Click the Upload button and upload the certificate.

Create a merchant identity certificate

In this task, you create the certificate signing request (CSR) for a Merchant Identity Certificate. (The steps below are adapted from Apple's tutorial on how to create a certificate signing request.)

1. Launch Keychain Access located in /Applications/Utilities.
2. Choose Keychain Access > Certificate Assistant > Request a Certificate from a Certificate Authority.
3. In the Certificate Assistant dialog, type an email address in the User Email Address field. (Any email address works.)
4. Type the Common Name. You may pick a common name of your choice. For example, "Nexio Apple Pay Merchant Cert".
5. Leave the CA Email Address field empty.
6. Choose Saved to disk, and click Continue.
7. The default Save As name is something like CertificateSigningRequest.certSigningRequest. You can name it whatever you want. For example, NexioApplePayMerchant.certSigningRequest.

Successful completion of the above steps creates the following files:

• CSR (saved to the location you selected with the name you chose in step 7)
• A private key (saved to the KeyChain tool, with the same name as the Common Name you chose in step 4)
• A public key (saved to the KeyChain tool, with the same name as Common Name you chose in step 4)
  

Upload the CSR to Apple's developer portal

1. Go to the Apple Developer Portal.
2. Click to expand the App IDs dropdown menu (in the top right).
3. Select Merchant IDs.
4. Select the desired merchant ID. (If you do not see the merchant ID, create it now).
5. Under "Apple Pay Merchant Identity Certificate", click Create Certificate.
6. Upload the merchant identity certificate you created previously.
7. Download the certificate. Name it NexioApplePayMerchant.cer.

Export the private key

1. Go back to the KeyChain tool on your Apple computer.

2. Right-click on the private key and select Export.

3. Export as 'NexioApplePayMerchantKey.p12'.

   Note: If "p12" is grayed out, you chose the wrong key. Select a different key.
   

Convert the format of the private key

Convert the format of the private key you downloaded in step 3 of Export the private key. Convert it first to a PEM certificate, then to a Base64 string.

1. Open the terminal.

2. Navigate to the directory where the private key is saved (Documents, by default): cd Documents.

3. Create the privatePem by typing the following in the terminal:

   openssl pkcs12 -in NexioApplePayMerchantKey.p12 -out NexioApplePayMerchantKey.pem -nodes -clcerts

4. Convert .pem file to a Base64 string: base64 -i NexioApplePayMerchantCRT.pem

Convert the format of the Apple Pay certificate

Convert the format of the certificate you downloaded in step 3 of Convert the format of the private key. Convert it first to a PEM certificate, then to a Base64 string.

1. Navigate to the directory where the private key is saved (Downloads, by default): cd Downloads.

2. Create the certPem by typing the following in the terminal:

   openssl x509 -inform DER -outform PEM -in NexioApplePayMerchant.cer -out NexioApplePayMerchantCRT.pem

3. Convert the files to base64 strings: base64 -i NexioApplePayMerchantCRT.pem

Verify your domain

Follow these steps to verify the domain to be used with Apple Pay. If you have multiple domains (for example, for development environments) repeat these steps for each.

1. Go to the Apple Developer portal.
2. Click Merchant Domains.
3. Click Add Domain.
4. Enter the URL of the domain you plan to use. Click Save.
5. Apple Pay will provide you with a text file to download and a URL. Download the file and copy the URL, you will use both in the next step.
6. Host the text file at the exact URL provided by Apple.

Provide your configuration settings to Integrations Support

After you have completed all of the previous tasks, contact Integrations Support to provide them with the following:

• Your Apple Pay Merchant ID.

• Your Payment Processing Certificate.

• Your Merchant Identity Certificate.

• Your gateway credentials.

• The verified domain for processing.

  If you have multiple verified domains for testing purposes, you can dynamically choose the domain by providing the appropriate value for the data.applePayDomain parameter when you request a one-time-use token. (For more information, see step 4 of the Button Iframe URLs tutorial).

Troubleshoot the configuration or platform

Apple Pay and Apple Developer use different platforms. You need to accept the terms and conditions on each account separately.

If you are experiencing difficulties on one of the platforms, please contact the appropriate support:

• Apple Pay support
• Apple Developer support

Integration flow

The general integration flow is the same for all APMs and depends on which APMs you want to integrate with.

First, the decision about which APMs to use affects the possible integration methods and the required parameters for the APM one-time-use token request. Use the information from this integration guide with the information from any other applicable integration guides as you plan your integration. In order to integrate an APM after it has been added to your merchant account, you need to decide which integration method you want to use, which may be dependent on the method you have used with other APMs. Note that you can mix and match those methods for each APM but your page may not look as usable or clear as when using a single method. There are pros and cons to each method. For additional information, see the Supported integration methods for APMs topic.

After deciding on the integration method, you need to make sure that you know which currencies are supported (for an overview of all APMs, see Supported currencies for APMs) and which parameters are required in a request. This is especially important for integrations with multiple APMs. Make sure that all the required parameters are accounted for across all the APMs used. For an overview of common parameters across the APMs, see Common required parameters.

You also need to decide whether you want to specify where you want the APM to return the customer after they pay or just to the page that opened the APM payment page. If you specify a page, you must include the customerRedirectUrl parameter in the APM one-time-use token request, you need to create that page on your site, and you need to create the code for the page that parses the query string parameters passed along with that redirect URL. Note that you must use this option when using the custom integration method. If you use the referring page, that page needs to listen for event messages.

In addition to either of the previous options, you should also configure webhooks to get event messages. This is especially helpful for instances where the APM process fails or there are problems with a transaction request.

Next, decide on where you are displaying the APM as a payment option (on a product page, shopping cart page, checkout page, or some combination of those. For example, PayPal (with Braintree) has a “Continue button” flow that you can use on a shopping cart page, which may affect how you integrate.

On each page where you are putting the APM option, first you need an APM one-time-use token. This is where you can send most of the required parameters. If necessary, you can also send customization options for the iframe display (whether multi or individual). This returns URLs and an APM token that you use for the integration method you want. Use this URL for the iframe or link. Each APM gets a different URL (except for the multi-iframe method, which gets one for all APMs that are supported).

You will also want to note the asyncTraceId (it is the same for all APMs returned from the APM one-time-use token) because you can use that to track the status of the transaction and narrow down the problem when troubleshooting.

Many of the APMs open a new webpage when the customer selects to pay using that method. The ideal payment flow returns control to the merchant website after the customer authenticates and pays from the APM website. As mentioned previously, your integration needs to include code that gets the data returned from the APM. This will be in the URL query parameters or as event messages or as webhooks. Use this information for display a payment success or failure message for the customer.

Required fields

The following table shows the required and optional fields for Apple Pay transactions in the Create APM one-time-use token request.

Example requests

The following are example one-time-use token requests for Apple Pay.

curl -X POST https://api.nexiopaysandbox.com/apm/v3/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "USD",
    "paymentMethod": "applePayAuthNet",
    "customer": {
      "orderNumber": "12345678",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]"
    }
  }
}'

curl -X POST https://api.nexiopaysandbox.com/apm/v3/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "USD",
    "description": "test purchase",
    "paymentMethod": "applePayCyberSource",
    "customer": {
      "orderNumber": "12345678",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "billToAddressOne": "123 Test St",
      "billToCity": "Testerville",
      "billToState": "UT",
      "billToPostal": "12345",
      "billToCountry": "US"
    }
  }
}'

{
  "expiration": "2018-09-18T15:43:05.664Z",
  "token": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "asyncTraceId": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "expressIFrameUrl": "https://www.api.nexiopaysandbox.com/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "redirectUrls": [],
  "buttonIFrameUrls": [
    {
      "paymentMethod": "payPal",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=payPal"
    },
    {
      "paymentMethod": "applePayAuthNet",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=applePayAuthNet"
    },
    {
      "paymentMethod": "applePayCyberSource",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=applePayCyberSource"
    }
  ]
}

For the multi iframe integration method: You use the expressIFrameUrl value in the steps for the transaction.

For the individual iframe option: You use the buttonIFrameUrls.url of the Apple Pay APM for the transaction. Also, you use the scriptUrl.

Transaction types and integration methods

Regardless of the integration method workflow you implement, consumers are redirected to Apple Pay to complete their transactions.

Nexio supports the following transaction types for Apple Pay:

• Auth Only
• Sale
  • In an iframe that displays all payment methods available to the customer (based on the customer’s location and the merchant’s configured payment methods)
  • In an individual iframe
    
• Void
• Capture
• Refund

Testing Data

For testing data, see Apple Pay’s Sandbox Testing page.

Response handling

In the one-time-use token request, Apple Pay gets returned in the paymentMethod parameter as applePayAuthNet or applePayCyberSource.

Nexio responds with transaction results in event messages.

For information about how to run each of the integration workflows, see Transaction types and integration methods above.

Webhooks

In addition to the event message, if your merchant account is configured to receive webhooks, Nexio provides responses to the webhook URLs that have been registered. For additional information about webhooks, see the Webhooks topic.

The response you get depends on the type of webhooks you have configured.

• New - The new Nexio webhooks.
• Legacy - The legacy webhooks.

New webhooks

For Apple Pay, the new webhook eventType will always be TRANSACTION with a processMethod value of 20 (for APMs).

Those TRANSACTION webhooks will also contain a numerical value for transactionStatus whenever that status changes. For specific information about the status values, see the Transaction status reference tables in the "Constant transaction values" topic. You can also reference the "Status workflows" table below.

For information about what information gets received in a webhook and how to use it, see the Receiving webhooks topic.

Legacy webhooks

For Apple Pay, these are the possible legacy webhook event types:

• TRANSACTION_AUTHORIZED
• TRANSACTION_CAPTURED
• TRANSACTION_REFUNDED
• TRANSACTION_SETTLED
• TRANSACTION_VOIDED

For further explanation of the webhook event types, see the legacy webhook Event types table.

Status workflows

The status of a successful transaction with Apple Pay varies, depending on the options you choose.

*Pending status displays as "authorized" or "AUTHORIZED" in the Nexio Dashboard; it displays as 10, meaning "authorized", in the response when querying transactions (for more information about transactionStatus, see the table).

Next steps

Now, you are ready to get started with running transactions:

• Run a sale transaction

If you have any additional questions or feedback, see Contact us.