Integrate Apple Pay

Here's how to integrate Apple Pay into your Cards solution.

Introduction

To add Apple Pay to your Cards solution, you will have to complete these 3 steps:

1. Commercial agreement signing

The first step to offer Apple Pay is to agree on and sign the commercial terms with us. If you haven't done so yet, get in touch with our sales team.

2. BIN configuration

Here's how to obtain some necessary data to complete the form and configure your BIN for Apple Pay.

👉🏼 Team ID

1. Go to the Apple Developers site and log in with your credentials.
2. Scroll down to "Membership Details".
3. There you will find your Team ID.

👉🏼 ADAM, Apple ID, and Bundle ID

1. Log in to App Store Connect with your credentials.
2. Select "My Apps" and choose the corresponding application.
3. Go to the "App Information" option in the left navigation menu and then to general information.
4. There you will find the Apple ID and the Bundle ID.

👉🏼 Signed agreement

You will have to sign an agreement to let Apple know that you will be offering Tokenization services with us. To do this, get in touch with our Integration team.

Important: You can sign it by hand and scan it or use a digital signature.

👉🏼 Marketing asset

Apple requires you to attach at least one marketing piece advertising that you offer Tokenization service with Apple Pay. Additionally, they will validate that you comply with their Marketing Guide and assets.

Here, we share the assets corresponding to each country so that you can create your marketing pieces:

• Mexico Assets Guide
• Colombia Assets Guide
• Brazil Assets Guide
• Argentina Assets Guide
• Peru Assets Guide

We also provide some examples for reference:

• Example Spanish email 01
• Example Spanish email 02
• Example Portuguese email 01
• Example Portuguese email 02

3. Technical adjustments

We will share a step-by-step guide with the technical adjustments you will need to make to support Apple Pay in your application. Since it is Apple's own functionality, you will have to make the adjustments in their native programming language, which is Swift.

👉🏼 Add the button to start the flow

You will need to add a button to your card view that allows you to start the flow as in the following example:

👉🏼 Generate information to provision a card using our endpoint

To provision a card in Apple Pay, the first thing you need to do is generate the information that you will later send to Apple so that your customers can enroll their cards in the wallet. You do this using this endpoint.

👉🏼 Provision the token

Here's a step-by-step guide on how to provision a token to your customer's card.

Step 1 - Verify that the device and your application are compatible with Apple Pay

Step 2 - Start the flow

Step 3 - Build the object

Step 4 - Notify the client of the error

Step 5 - Get the card information

In this step, we provide an example as hardcoded, but in your application, you will need to build a mechanism to retrieve your user's card information. Remember that in step 3 we create a variable, let card = cardInformation(), and that is what we are using in this step.

To obtain the card data, you will need to follow the steps in this documentation.

Step 6 - Contact Apple and Pomelo

First, you will need to call the PKAddPaymentPassViewControllerDelegate function to get the information that you will later use to contact us.

Then, you will need to build the IssuerRequest object with the response you obtained in the previous step and contact us using this endpoint.

Finally, with the response you obtained from our endpoint, you will need to make the call to Apple to continue the provisioning flow using the PKAddPaymentPassRequest(). function.

Step 7 - Listen to the provisioning result

Additional documentation

If you need it, we provide this troubleshooting guide.

Important:

• For now, you can use a single card art per BIN.
• For the Manual Provisioning flow, you should not make any adjustments to your technical integration.
• From the moment we receive the completed form and load the configuration in the brand network, you will have to wait at least 10 business days for the changes to take effect.
• You will need to share between 5 and 20 'card-id' with us so that we can enable those cards for testing the flows.
  • These 'card-id' must correspond to productive cards.
  • Once you have successfully validated that everything is functioning as expected, get in touch with us so that we can enable the entirety of your BIN for Apple Pay. This is a process that needs to be coordinated with the brand network.
• You will need to have your customers' email address and cell phone number registered with area code without symbol in order to send them the identity validation verification code. Example: 541123456777
  • In case your customers do not have updated information, you can update it using this endpoint.