Tap Payments · Connector Onboarding

Explore

Tap Payments

Don’t have a Tap Payments account:

Reach out to your Apaya Account Manager or

⁠

Ensure that when interacting with your Tap Payments account manager that you tell them that Apaya is your integration partner.

Already have a Tap Payments account:

IMPORTANT: Inform your Tap Payments account manager that Apaya is your integration partner.

Contact Tap Payments to retrieve your Merchant ID.

On the Apaya Portal, go to ‘Connectors’ and click on the Tap logo. If Tap is already listed in ‘My Connectors’, click the ‘edit’ icon.

Enter the following data in the Apaya Portal ‘Edit Account’ section for Tap as shown below:

MerchantID - Your Merchant ID as supplied by Tap.

SendSMS - Set to ‘True’ or ‘False’ if you want your customers to receive an SMS receipt after their transaction.

SendEmail - Set to ‘True’ or ‘False’ if you want your customers to receive an Email receipt after their transaction.

Note: Both SendSMS and SendEmail only deliver to the customer on the Production environment and not on Sandbox. You must provide your customer’s mobile number and/or email address to use these features accordingly via your API integration with Apaya.

Note: To utilise Google Pay, provide the following:

GoogleMerchantId - Set to your Google Pay Merchant ID on Production (or set to anything on Sandbox)

GoogleMerchantName - Set to your Google Pay Merchant Name on Production (or set to anything on Sandbox)

If you don’t have these details then enter any string, e.g. ‘-’ or ‘UNAVAILABLE’.

If you are a sub-merchant of Apaya on TapOS:

RetailPlatformID: N/A

MerchantSecretKey: N/A

PlatformRSACert: N/A

If you are a sub-merchant of a Retail Platform on TapOS:

Sandbox:

RetailPlatformID: The Retail Platform ID of your parent merchant

MerchantSecretKey: The TEST bearer token (secret key) of your parent merchant

PlatformRSACert: The TEST RSA certificate of your parent merchant

Production:

RetailPlatformID: The Retail Platform ID of your parent merchant

MerchantSecretKey: The LIVE bearer token (secret key) of your parent merchant

PlatformRSACert: The LIVE RSA certificate of your parent merchant

If you are using Apple Pay within an iFrame see steps below for Technical setup for Apple Pay.

If you are not using Apple Pay within an iFrame populate:

AppleMerchantInitiatedDomain: N/A

⁠

Technical setup for Apple Pay:

In the Apaya Portal, you will need to enter your Tap credentials detailed above.

For your Tap credentials, follow steps 1-7 if you have not already.

For the Apple Pay specific details:

For merchants registered as Apaya sub-merchants on TapOS:

Sandbox:

AppleMerchantIdentifier: merchant.io.apaya.taptest

AppleMerchantDisplayName: ApayaTapTest

Production:

AppleMerchantIdentifier: merchant.io.apaya.taplive

AppleMerchantDisplayName: ApayaTapLive

For merchants registered as Retail Platform sub-merchants on TapOS:

Sandbox/Production:

AppleMerchantIdentifier: Provided by Apaya depending our your Retail Platform parent merchant

AppleMerchantDisplayName: Provided by Apaya depending our your Retail Platform parent merchant

If you are using Apple Pay within an iFrame you will need to set up the following:

Add 'Apple's Root Certificate' to your own website:

Go to the following Apple link:

https://www.apple.com/certificateauthority/⁠

⁠

Choose the 'Apple Inc Root' link to download the certificate and install on your web server

You (the merchant) must send the full URL of the iFrame's parent-page, including sub-domains to your Apaya Account Manager

Apaya will register and validate your parent-page URL with Apple

Apaya will be prompted to download a validation file which Apaya will send to you

You must upload this file to your platform in the following location of your website (create if it doesn't exist):

wwwroot/.well-known/

Once uploaded, notify your Apaya Account Manager of the upload so we can verify the domain on the Apple Developer Portal

Update your Tap Connector Configuration on the Apaya Portal:

Populate AppleMerchantInitiatedDomain: Your domain, provided to and verified by Apaya in steps 1-5 above.

Navigate to the Connectors screen on the Apaya Portal, and click edit on your Tap connector. Update/add your Apple Pay credentials as shown in the previous section and ensure Merchant ID, AppleMerchantIdentifier and AppleMerchantDisplayName are populated.

Test transactions:

To test a transaction using Tap Payments, refer to the instructions

here⁠

⁠

Want to print your doc?
This is not the way.

Try clicking the ··· in the right corner or using a keyboard shortcut (

CtrlP

) instead.