# Hosted Merchant Onboarding

The **Hosted Merchant Onboarding** gives you a prebuilt application flow for merchant onboarding. Merchants can complete the application, upload documents, and sign agreements to onboard easily.

### **Prerequisites** <a href="#prerequisites" id="prerequisites"></a>

To use the hosted merchant onboarding process, ensure you have the following:

✅ A test environment URL.&#x20;

{% hint style="info" %}
Contact [Xplor Pay Getting Started](https://xplorpay.com/getting-started/) to get test environment URL.
{% endhint %}

✅ Webhook URL to receive onboarding status updates.

{% hint style="info" %}
Visit [Register Endpoint](https://app.gitbook.com/s/j9heLdoDRsfnChUQohvj/webhooks/register-endpoint "mention") and learn how to register your URL.
{% endhint %}

✅ The required integration settings for your account.

{% hint style="info" %}
Contact to [Xplor Pay](https://xplorpay.com/contact/) for integration settings.
{% endhint %}

{% stepper %}
{% step %}

### Get onboarding application URL

To get the onboarding application URL:

1. Use the POST method.
2. Send a request to the [Hosted Merchant Onboarding](https://app.gitbook.com/s/j9heLdoDRsfnChUQohvj/api/merchant-onboarding/hosted-merchant-onboarding "mention") API endpoint with the required fields.

{% code overflow="wrap" lineNumbers="true" %}

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

{% endcode %}

The response returns the application URL in the `applicationURL` field.

{% code overflow="wrap" lineNumbers="true" %}

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

{% endcode %}

This URL directs the merchant to the onboarding page, where they can complete and submit the form.
{% endstep %}

{% step %}

### Application submission

The onboarding page shows all required fields for submission.

Use the sample data in the table to test the onboarding flow.

<table><thead><tr><th valign="top">Field name</th><th valign="top">Sample value</th></tr></thead><tbody><tr><td valign="top">Federal Tax ID</td><td valign="top">99-9000004</td></tr><tr><td valign="top">Routing Number (ABA)</td><td valign="top">083000137</td></tr><tr><td valign="top">Checking Account number</td><td valign="top">123542352343</td></tr></tbody></table>

When merchant selects **Submit**, Xplor Pay validates the data. If the information is valid, the merchant is prompted to sign the agreement digitally.
{% endstep %}

{% step %}

### Pricing configuration

The hosted onboarding application applies default pricing based on your partner account structure.

{% hint style="info" %}
See [Adding Hierarchy & Compensation Details](https://app.gitbook.com/s/Us4U42giioY3jQj0TJQl/partner-portal/guides/merchant-onboarding-via-partner-portal/adding-hierarchy-and-compensation-details "mention") to manage partner hierarchy in your account.
{% endhint %}

To configure the pricing in the onboarding application, see:

* [Custom pricing](https://app.gitbook.com/s/yN9CLsR8tlS8G8avRMB5/merchant-onboarding/hosted-merchant-onboarding/configure-merchant-pricing/custom-pricing "mention")
* [Empower pricing](https://app.gitbook.com/s/yN9CLsR8tlS8G8avRMB5/merchant-onboarding/hosted-merchant-onboarding/configure-merchant-pricing/empower-pricing "mention")
  {% endstep %}
  {% endstepper %}