Creating a Merchant Application

Note: The following steps are performed by the Partner, who is responsible for collecting merchant details and initiating the onboarding process.

To begin onboarding a merchant through the Hosted Merchant Onboarding application, you’ll use the Launch Integrators Setup API to submit the merchant’s basic information. This includes email address, DBA (Doing Business As) name, and MCC (Merchant Category Code). These details are used to generate a unique application link.

You can initiate the onboarding process by submitting a minimal set of required fields (e.g., DBA, email, MCC). The application creation endpoint accepts partial requests and fills in default values where applicable.

This method is suitable for partners who collect basic merchant data upfront and prefer to complete the rest of the information during the hosted onboarding flow.

1

Create a Merchant Application

Use the POST method /api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey} to create a new merchant application using the minimal required fields. Refer to the below sample code for reference:

{
    "merchantInformation": {
        "dbaName": "Stark Industries",
        "emailAddress": "[email protected]"
    },
    "salesProfile": {
        "mccCode": "5085"
    }
}

To enhance the onboarding experience and reduce form completion time, send all available merchant details in the initial request. This reduces manual input, pre-fills the onboarding form, and speeds up the process. Refer to the below full sample code for reference:

{
  "merchantInformation": {
    "dbaName": "Jane's Sandwich Shop",
    "merchantNumber": "6588000099990000",
    "emailAddress": "[email protected]",
    "website": "www.jane-doe0sandwiches.com",
    "phones": [
      {
        "phoneTypeId": 3,
        "areaCode": "313",
        "phoneNumber": "3334444",
        "extension": "ext. 5"
      }
    ],
    "acceptsPaperStatements": true,
    "acceptsPaperTaxForms": true,
    "companyTypeId": 8,
    "seasonalSchedule": {
      "april": true,
      "august": true,
      "december": true,
      "february": true,
      "january": true,
      "july": true,
      "june": true,
      "march": true,
      "may": true,
      "november": true,
      "october": true,
      "september": true
    },
    "salesInformation": {
      "assignedUser": 1,
      "referralPartner": "text",
      "compensationType": 1
    }
  },
  "mailingAddress": {
    "line1": "1011 NORTHWEST AVE",
    "line2": "APT 223",
    "line3": "",
    "city": "ST LOUIS",
    "stateCode": "MO",
    "zip": "Doe",
    "countryCode": 840
  },
  "physicalAddress": {
    "line1": "1011 NORTHWEST AVE",
    "line2": "APT 223",
    "line3": "",
    "city": "ST LOUIS",
    "stateCode": "MO",
    "zip": "Doe",
    "countryCode": 840
  },
  "bankAccounts": [
    {
      "bankName": "Wells Fargo",
      "nameOnAccount": "Food Sales LLC",
      "accountHolderFirstName": "Jane",
      "accountHolderLastName": "Doe",
      "bankAccountTypeId": 1,
      "bankAccountNameTypeId": 2,
      "aba": "091000019",
      "accountNumber": "77777888888888",
      "hasFees": true,
      "hasFunds": true,
      "hasChargebacks": true,
      "currency": "USD",
      "purpose": "Settlement"
    }
  ],
  "businessContacts": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "ssn": "Doe",
      "dateOfBirth": "Doe",
      "countryOfCitizenshipCode": 840,
      "line1": "1011 NORTHWEST AVE",
      "line2": "APT 223",
      "line3": "Doe",
      "city": "ST LOUIS",
      "stateCode": "MO",
      "zip": "Doe",
      "countryCode": 840,
      "ownershipAmount": 80,
      "emailAddress": "[email protected]",
      "title": "CFO",
      "phoneNumbers": [
        {
          "phoneTypeId": 3,
          "areaCode": "313",
          "number": "3334444",
          "extension": "ext. 5"
        }
      ],
      "contactTypes": [
        1,
        2,
        3
      ],
      "isCompassUser": true,
      "isAuthorizedToPurchase": true
    }
  ],
  "salesProfile": {
    "useExtraCnpValidation": true,
    "mccCode": "5812",
    "isECommerce": true,
    "cardPresentPercentage": 50,
    "motoKeyedPercentage": 50,
    "eCommercePercentage": 50,
    "returnRefundPolicy": "Refunds are available within 90 days.",
    "productsSold": "Food and beverages.",
    "previouslyAcceptedPaymentCards": true,
    "previouslyTerminatedOrIdentifiedByRiskMonitoring": true,
    "reasonPreviouslyTerminatedOrIdentifiedByRisk": "Stolen identity",
    "currentlyOpenForBusiness": true,
    "annualVolume": 550000,
    "averageTicket": 50.12,
    "highTicket": 575,
    "ownsProduct": true,
    "ordersProduct": false,
    "sellsFirearms": false,
    "sellsFirearmAccessories": false,
    "futureDeliveryTypeId": false,
    "otherDeliveryType": "Stolen identity",
    "futureDeliveryPercentage": 75,
    "fireArmsLicense": "199888776Y5555",
    "cardBrands": [
      1,
      2,
      3,
      4
    ],
    "ebtNumber": "1999991",
    "amexMID": "1999991",
    "sellsCBD": true,
    "cbdSalesTypeID": 1,
    "salesProfileCBD": {
      "annualCBDRevenuePercentage": 35,
      "cbdProductInventoryPercentage": 75,
      "cbdCategoryID": 1,
      "incorporatedDate": "2020-11-30T00:00:00"
    }
  },
  "taxpayer": {
    "tin": "999889999",
    "tinTypeId": 1,
    "businessLegalName": "Some Business LLC",
    "stateIncorporatedCode": "MO"
  },
  "externalCustomerId": "id28829382999",
  "pricingPlan": {
    "pricingFees": [
      {
        "clearentPricingFeeID": 1,
        "pricingFeeDescription": "text",
        "rate": 1,
        "fee": 1,
        "payInMonth1": 1,
        "payInMonth2": 1
      }
    ],
    "pricingPlanID": 1,
    "pricingPlanTemplateID": 1,
    "pricingTypeCode": "text",
    "isAdvancedPricing": true,
    "isEMF": true,
    "isDailySettle": true,
    "includeAssessments": true
  },
  "applicationExpirationTime": 7
}

2

Redirecting the Merchant

After submitting the request, the response includes an applicationURL, which the merchant can use to complete their application. Refer to the below sample code for reference:

{
  "applicationURL": "https://boarding-sb.clearent.net/launch-integrator-setup/merchant/4c87c74b-a483-4d4f-8656-b46a59e2e3d4"
}

You can optionally redirect the merchant directly to the hosted application using the redirect URL.

Xplor Pay also sends a Welcome email to the merchant containing the same application link.

The merchant is then redirected to the hosted application page to:

1. Review and complete application details

2. Upload the required documentation

3. Digitally sign agreements

This application link is valid for 30 days. After that, it expires, and a new application must be generated.