Skip to main content
This guide walks through the full merchant boarding lifecycle — from creating the initial lead 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

1

Create the lead

A lead is the merchant application record. All subsequent data — business info, pricing, equipment, and compliance — attaches to this record.Endpoint: Create Lead — POST /v1/crm/leadsAt minimum, provide the merchant’s DBA name, legal name, and the agent or ISO the lead belongs to. Refer to the Leads Overview for a full description of the lead lifecycle and available fields.
POST /v1/crm/leads
Authorization: Api-Key <your-api-key>
2

Add business profile

Populate the merchant’s business details on the lead.
  • Address — Add Lead Address (POST /v1/crm/leads/{leadId}/addresses). Add the physical business location.
  • Principals — Add Lead Principal (POST /v1/crm/leads/{leadId}/principals). Capture each beneficial owner and signer. SSN and date of birth are encrypted at rest.
3

Add banking / deposit information

Provide ACH funding account details so the merchant can receive deposits.Endpoint: Create Lead Deposit Info — POST /v1/crm/leads/{leadId}/deposit-infoSensitive bank fields are encrypted. Use Decrypt Lead Deposit Info to retrieve them later.
4

Configure pricing

Attach the fee structure that will apply to the merchant after boarding.
  • Pricing package — Create Pricing Package (POST /v1/crm/leads/{leadId}/pricing-packages). Group related fee configurations.
  • Pricing items — Create 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 (POST /v1/crm/leads/{leadId}/pricing-rules). Apply conditional pricing logic if required.
5

Add equipment order (optional)

If the merchant requires physical terminal hardware, create an equipment order on the lead.
6

Attach supporting documents

Upload any required underwriting or compliance documents.Endpoint: Create Lead Document — POST /v1/crm/leads/{leadId}/documents
7

Run compliance validations

Before submission, run identity and risk screening checks against the lead.
CheckEndpoint
Completeness checkValidate Completeness
Tax ID verificationTinCheck
Identity verificationDataX
Credit & state IDEquifax
Bank accountGIACT
Terminated merchantMATCH Pro
Resolve any failures before proceeding to review.
8

Send for e-signature

Generate an MPA (Merchant Processing Agreement) signing session for the merchant to review and sign.Endpoint: Create Signing Session — POST /v1/crm/leads/{leadId}/signingOnce the session is created, share the signing URL with the merchant. Use Verify Signing Token to confirm completion.
9

Submit for review

Submit the lead to underwriting or compliance for final review.Endpoint: 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.
10

Transition status through the pipeline

As the review progresses, update the lead’s status.Endpoint: Transition Lead Status — PUT /v1/crm/leads/{leadId}/transition/{status}See the Leads Overview for a description of available statuses and valid transitions.
11

Retrieve the assigned MID

Once the lead is approved and boarding is complete, the merchant is assigned a Merchant ID (MID).Endpoint: Get Lead MID — GET /v1/crm/leads/{leadId}/midAt this point the merchant becomes an active client record in the system.

Leads Overview

Full reference for the lead lifecycle, status pipeline, and all available sub-resources.

Financial Reporting

Transactions, batches, deposits, and statements for active merchants.