Hosted Merchant Onboarding

The Hosted Merchant Onboarding API provides a prebuilt, secure hosted flow for merchant onboarding. Merchants can enter their business details, review and sign terms, and complete the application to onboard easily.

This solution automates key onboarding steps, including merchant account creation, data validation, and pricing configuration.

Hosted Merchant Onboarding is designed for quick integration. It requires minimal development effort while relying on Xplor Pay to manage the onboarding workflow and validation.

Hosted Merchant Onboarding was previously referred to as Launch for Integrator (L4I). You may still see references to L4I in system messages, APIs, or legacy documentation.

Hosted merchant onboarding steps

Follow the steps below to onboard a merchant using the hosted application:

1

Generate application URL

To get an onboarding application URL, use the Create New Merchant endpoint to initiate onboarding for a merchant under your partner hierarchy node. This endpoint supports both minimal and complete payloads and applies default values when optional fields are not provided.

The application creation endpoint accepts partial requests and fills in default values where applicable.

Submit the required minimal merchant details, such as DBA name, email address, and MCC, to generate an application URL. This option is suitable when you collect only basic merchant information upfront and allow the merchant to complete the remaining details in the hosted flow.

{
  "merchantInformation": {
    "dbaName": "test-L4I",
    "emailAddress": "[e-mail]"
  },
  "salesProfile": {
    "mccCode": "4582"
  },
  "pendEmailAddress": "[e-mail]"
  "secondaryPendEmailAddress": "[e-mail]"
}

The API creates a new merchant application and returns an application URL in the applicationURL field.

In the request body, the pendEmailAddress field specifies the email address that receives application status update notifications, such as Signed, Approved, Pended, or Declined. The optional secondaryPendEmailAddress field specifies an additional email address that receives merchant correspondence.

• If pendEmailAddress is provided, the system sends application status update notifications to this email address.
• If pendEmailAddress is not provided, the system uses the address [e-mail] as the default.
• If secondaryPendEmailAddress is provided, the system sends merchant correspondence to this email address.
• If secondaryPendEmailAddress is not provided, no secondary recipient is added.

2

Submit complete payload (optional)

Submit additional merchant details to prefill the hosted application and reduce manual data entry. Providing a complete payload improves the onboarding experience and helps merchants complete the application faster.

Use this approach when merchant data is already available, such as business details, addresses, bank accounts, ownership information, and pricing configuration.

3

Redirect merchant

The application URL directs the merchant to the hosted onboarding page to complete the application.

Xplor Pay triggers a welcome email to the merchant containing the same link.

4

Complete application

The onboarding page shows the required fields for submitting the application. Merchants can enter business details and review additional required information.

In the onboarding page, the merchant can:

• Review and complete application details
• Upload required documentation
• Digitally sign agreements

The application URL remains valid for 30 days. After expiration, generate a new application to complete onboarding.

5

Submit application

When a merchant submits the application, Xplor Pay validates the data and allows the merchant to sign the agreement digitally.

6

Pricing configuration

The hosted onboarding application applies the default pricing plan based on your partner account structure. You can configure the pricing using custom or empower pricing.

To apply and configure default, custom, or empower pricing for eligible merchants, see Pricing Plan and Reference.