# Get merchant onboarding application URL

Get a merchant application URL to initiate Hosted Merchant Onboarding. This step generates a secure application URL that allows the merchant to complete onboarding through the hosted experience.

Use the [Launch Integrators Setup API](https://app.gitbook.com/s/j9heLdoDRsfnChUQohvj/api/merchant-onboarding/hosted-merchant-onboarding) to submit merchant details. The API supports both minimal and complete payloads and applies default values when optional fields are not provided.

{% hint style="warning" %}
The application creation endpoint accepts partial requests and fills in default values where applicable.
{% endhint %}

{% stepper %}
{% step %}

### **Generate application URL**

Use the POST method to call `/api/launchIntegratorSetup/v1.0/integrateMerchant/{hierarchyNodeKey}` endpoint. Submit the required 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.

This request creates a new merchant application and returns a unique application URL. The following is the minimal required request body:

{% code lineNumbers="true" %}

```javascript
{
  "merchantInformation": {
    "dbaName": "Example-dba",
    "emailAddress": "janedoe@clearent.com"
  },
  "salesProfile": {
    "MccCode": "9999"
  },
  "pendEmailAddress": "user@example.com"
}
```

{% endcode %}

The `pendEmailAddress`  field specifies the email address that receives application status update notifications, such as Signed, Approved, Pended, or Declined.

{% hint style="success" %}

* If `pendEmail` field is provided, the system sends notifications to this email address.
* If not provided, the system uses the address <no-reply@xplorpay.com> as default.
  {% endhint %}
  {% endstep %}

{% step %}

### 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.

{% code lineNumbers="true" fullWidth="true" %}

```json
{
  "merchantInformation": {
    "dbaName": "Example-dba",
    "merchantNumber": "6588000099990000",
    "emailAddress": "janedoe@clearent.com",
    "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": "someone@clearent.com",
      "title": "CFO",
      "phoneNumbers": [
        {
          "phoneTypeId": 3,
          "areaCode": "313",
          "number": "3334444",
          "extension": "ext. 5"
        }
      ],
      "contactTypes": [
        1,
        2,
        3
      ],
      "isCompassUser": true,
      "isAuthorizedToPurchase": true
    }
  ],
  "salesProfile": {
    "useExtraCnpValidation": true,
    "mccCode": "9999",
    "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": 30,
  "pendEmailAddress": "user@example.com"
}
```

{% endcode %}
{% endstep %}

{% step %}

### **Retrieve the merchant onboarding application URL**

The API response includes an `applicationURL`, which identifies the hosted onboarding application created for the merchant. Using it, the merchant can complete the onboarding application.

{% code lineNumbers="true" %}

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

{% endcode %}
{% endstep %}

{% step %}

### Redirect the merchant

Redirect the merchant to the `applicationURL` to continue onboarding. Xplor Pay also sends a welcome email to the merchant containing the same link.

In the hosted onboarding application, the merchant can:

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

{% hint style="warning" %}
The application URL remains valid for ***30 days***. After expiration, generate a new application to continue onboarding.
{% endhint %}
{% endstep %}
{% endstepper %}