> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payhub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Boarding a Merchant

> End-to-end walkthrough for originating and activating a new merchant account on PayHub

This guide walks through the full merchant boarding lifecycle — from creating the initial application through compliance checks, e-signature, and final activation. Each step links to the relevant API endpoint or overview for details.

## Prerequisites

Before you start, you need an API key.

* **API key** — Long-lived keys for service-to-service integrations. Pass it as `Api-Key <your-api-key>` in the `Authorization` header.

***

## Boarding steps

<Steps>
  <Step title="Create the application">
    An application is the merchant application record. All subsequent data — business info, pricing, equipment, and compliance — attaches to this record.

    **Endpoint:** [Create Application](/api-reference/leads/create-lead) — `POST /v1/crm/leads`

    At minimum, provide the merchant's DBA name, legal name, and the agent or ISO the application belongs to. Refer to the [Applications Overview](/api-reference/leads/overview) for a full description of the application lifecycle and available fields.

    ```http theme={null}
    POST /v1/crm/leads
    Authorization: Api-Key <your-api-key>
    ```
  </Step>

  <Step title="Add business profile">
    Populate the merchant's business details on the application.

    * **Address** — [Add Application Address](/api-reference/leads/add-lead-address) (`POST /v1/crm/leads/{leadId}/addresses`). Add the physical business location.
    * **Principals** — [Add Application Principal](/api-reference/leads/add-lead-principal) (`POST /v1/crm/leads/{leadId}/principals`). Capture each beneficial owner and signer. SSN and date of birth are encrypted at rest.
  </Step>

  <Step title="Add banking / deposit information">
    Provide ACH funding account details so the merchant can receive deposits.

    **Endpoint:** [Create Application Deposit Info](/api-reference/leads/create-lead-deposit-info) — `POST /v1/crm/leads/{leadId}/deposit-info`

    Sensitive bank fields are encrypted. Use [Decrypt Application Deposit Info](/api-reference/leads/decrypt-lead-deposit-info) to retrieve them later.
  </Step>

  <Step title="Configure pricing">
    Attach the fee structure that will apply to the merchant after boarding.

    * **Pricing package** — [Create Pricing Package](/api-reference/leads/create-lead-pricing-package) (`POST /v1/crm/leads/{leadId}/pricing-packages`). Group related fee configurations.
    * **Pricing items** — [Create Pricing Item](/api-reference/leads/create-lead-pricing-item) (`POST /v1/crm/leads/{leadId}/pricing-items`). Add individual fees such as interchange, basis points, and per-transaction fees.
    * **Pricing rules** — [Create Pricing Rule](/api-reference/leads/create-lead-pricing-rule) (`POST /v1/crm/leads/{leadId}/pricing-rules`). Apply conditional pricing logic if required.
  </Step>

  <Step title="Add equipment order (optional)">
    If the merchant requires physical terminal hardware, create an equipment order on the application.

    * **Equipment order** — [Create Equipment Order](/api-reference/leads/create-lead-equipment-order) (`POST /v1/crm/leads/{leadId}/equipment-orders`).
    * **Order items** — [Create Equipment Order Item](/api-reference/leads/create-lead-equipment-order-item) — line items within the order.
    * **Gateway config** — [Create Equipment Order Gateway](/api-reference/leads/create-lead-equipment-order-gateway) — gateway assignment for the order.
  </Step>

  <Step title="Attach supporting documents">
    Upload any required underwriting or compliance documents.

    **Endpoint:** [Create Application Document](/api-reference/leads/create-lead-document) — `POST /v1/crm/leads/{leadId}/documents`
  </Step>

  <Step title="Send for e-signature">
    Generate an MPA (Merchant Processing Agreement) signing session for the merchant to review and sign.

    **Endpoint:** [Create Signing Session](/api-reference/leads/create-signing-session) — `POST /v1/crm/leads/{leadId}/signing`

    Once the session is created, share the signing URL with the merchant. Use [Verify Signing Token](/api-reference/leads/verify-signing-token) to confirm completion.
  </Step>

  <Step title="Submit for review">
    Submit the application to underwriting or compliance for final review.

    **Endpoint:** [Submit Application for Review](/api-reference/leads/submit-lead-for-review) — `PUT /v1/crm/leads/{leadId}/submit/{reviewer}`

    Pass `underwriting` or `compliance` as the `reviewer` path parameter depending on the required workflow.
  </Step>

  <Step title="Transition status through the pipeline">
    As the review progresses, update the application's status.

    **Endpoint:** [Transition Application Status](/api-reference/leads/transition-lead-status) — `PUT /v1/crm/leads/{leadId}/transition/{status}`

    See the [Applications Overview](/api-reference/leads/overview) for a description of available statuses and valid transitions.
  </Step>

  <Step title="Retrieve the assigned MID">
    Once the application is approved and boarding is complete, the merchant is assigned a Merchant ID (MID).

    **Endpoint:** [Get Application MID](/api-reference/leads/get-lead-mid) — `GET /v1/crm/leads/{leadId}/mid`

    At this point the merchant becomes an active client record in the system.
  </Step>
</Steps>

***

## Related resources

<CardGroup cols={2}>
  <Card title="Applications Overview" icon="file-text" href="/api-reference/leads/overview">
    Full reference for the application lifecycle, status pipeline, and all available sub-resources.
  </Card>

  <Card title="Financial Reporting" icon="chart-line" href="/api-reference/financial-reporting/overview">
    Transactions, batches, deposits, and statements for active merchants.
  </Card>
</CardGroup>