Merchant Onboarding for Your Tap Platform

Overview

Merchant onboarding connects merchants to your Tap platform account. This process:

1. Creates a Lead
2. Generates a Connect URL that guides merchants through signup
3. Results in an active Tap Merchant ID (MID) on your platform
4. Enables merchants to link and manage terminals

Prerequisites

Before you begin, ensure you have:

• ✅ An active Tap account registered as a Retail Platform
• ✅ Required segment keys from Tap's DX team for API integration

Step 1: Create a Lead

Pre-register merchants by submitting their details through the Create a Lead API. You'll receive a lead_id that stores all entity, business, user, and brand information on our servers for 30 days.

Step 2: Generate Connect Link

Pass the lead_xxx to the Create a Connect URL API. Redirect merchants to the Connect URL received in the response to complete their registration.

Step 3: Handle Webhooks

Merchant Webhooks

You'll receive merchant details once they successfully reach the Connect Board stage.

Use the saved Board URL to:

• Redirect merchants back to manage their KYC details
• Allow merchants to update their business information
• Complete pending verification steps

Terminal Webhooks

Configure your terminal_url in the lead setup to receive:

• ✅ Notifications when terminals are linked to merchants
• ✅ Notifications when terminals are unlinked from merchants

Board URL Webhooks

Save the Board URL from the Connect webhook in your database associated with the merchant record.

Important Notes

• The lead_id expires after 30 days if not used
• The Board URL remains valid for ongoing merchant management
• Ensure your WebHook endpoints are properly configured and secured
• Keep your API keys secure and never expose them in client-side code