Onboarding Merchants

To integrate a merchant with a POS system, follow these steps using the Connect Board:

Create a Lead

Use the Lead API to pre-register the merchant by entering user and entity details.

  • You will receive a lead_id. This ID contains all necessary entity, business, user, and brand details and will be stored on our internal servers for up to 30 days before it expires.

  • Include the operator object to link the POS Device ID to the merchant.

    "operator": {
      "device": {
        "reference": "", // POS Device ID
        "display_name": ""
      }
    }

Connect Step

Redirect the merchant to the Connect Board URL to complete their registration.

  1. Webhook Details
    The webhook received should include the following information:
    • Merchant details (once the merchant successfully reaches the Connect Board stage).
    • A unique board URL for each merchant, which can be used by the platform to manage the merchant account and redirect the merchant to complete the KYC flow.

Handle Webhook

Upon successful creation, merchant details are sent via a Connect webhook response.