Subsections
Lead Sources
Track referral channels and marketing campaigns that originate leads.
Addresses
Manage business addresses on a lead record.
Principals
Manage beneficial owners and signatories on a lead record.
Deposit Info
Manage bank account and deposit routing information for a lead.
Documents
Manage documents attached to a lead record.
Notes
Add and manage internal notes on a lead record.
Pricing
Manage pricing items, packages, and rules for a lead.
Equipment
Manage terminal equipment models and deployment orders for a lead.
Validations
Run identity, credit, and compliance checks against a lead.
Signing
Manage e-signature sessions for merchant application agreements.
Clear Identity Verification
Initiate and check Clear identity verification sessions for a lead.
Fast Apply
Streamlined public-facing MPA form endpoints for lead capture.
Lifecycle
Leads move through a configurable pipeline of statuses:- Use Transition status to move a lead to a new pipeline stage.
- Use Submit for review to send a lead to underwriting or compliance.
What’s included
Core
| Endpoint | Description |
|---|---|
| List leads | Retrieve a paginated list of leads |
| Create lead | Create a new merchant lead |
| Get lead | Retrieve a single lead by ID |
| Update lead | Update an existing lead record |
| Delete lead | Permanently delete a lead record |
| Transition status | Move a lead to a new status in the pipeline |
| Submit for review | Submit a lead for underwriting or compliance review |
| Get MID | Retrieve the assigned merchant identifier once boarding is complete |
| Update risk profile | Update the lead’s risk classification |
| Get service acceptance | Retrieve service terms acceptance status |
| Update service acceptance | Update service terms acceptance |
| Decrypt sensitive data | Decrypt a protected field (SSN, bank account, etc.) on demand |
Lead sources
| Endpoint | Description |
|---|---|
| List lead sources | Retrieve all lead sources |
| Create lead source | Create a new referral or campaign source |
| Get lead source | Retrieve a single lead source by ID |
| Update lead source | Update an existing lead source |
| Get source summary | Retrieve an aggregate summary for a lead source |
| List leads for source | Retrieve all leads associated with a lead source |
| List sources for lead | Retrieve all sources associated with a lead |
| Add source to lead | Associate a lead source with a lead |
| Remove source from lead | Remove a lead source association from a lead |
Business addresses
| Endpoint | Description |
|---|---|
| List addresses | Retrieve all business addresses for a lead |
| Add address | Add a business address to a lead |
| Get address | Retrieve a single business address |
| Update address | Update a business address |
Principals
| Endpoint | Description |
|---|---|
| List principals | Retrieve all principals associated with a lead |
| Add principal | Add a beneficial owner or signer to a lead |
| Get principal | Retrieve a single principal by ID |
| Update principal | Update a lead principal’s information |
| Delete principal | Remove a principal from a lead record |
| Decrypt principal data | Decrypt a sensitive field on a principal |
Deposit info
| Endpoint | Description |
|---|---|
| List deposit info | Retrieve all deposit info records for a lead |
| Create deposit info | Add a deposit info record to a lead |
| Get deposit info | Retrieve a single deposit info record |
| Update deposit info | Update a deposit info record |
| Delete deposit info | Remove a deposit info record from a lead |
| Decrypt deposit info | Decrypt a sensitive field on a deposit info record |
Documents
| Endpoint | Description |
|---|---|
| List documents | Retrieve all documents for a lead |
| Create document | Attach a document to a lead |
| Get document | Retrieve a single lead document |
| Update document | Update document metadata |
| Delete document | Remove a document from a lead |
Notes
| Endpoint | Description |
|---|---|
| List notes | Retrieve all notes on a lead record |
| Create note | Add a note to a lead record |
| Get note | Retrieve a single note |
| Update note | Edit a note on a lead record |
Pricing items
| Endpoint | Description |
|---|---|
| List pricing items | Retrieve all pricing items for a lead |
| Create pricing item | Add a pricing item (e.g. interchange, basis points) to a lead |
| Get pricing item | Retrieve a single pricing item |
| Update pricing item | Update a lead pricing item |
| Delete pricing item | Remove a pricing item from a lead |
Pricing packages
| Endpoint | Description |
|---|---|
| List pricing packages | Retrieve all pricing packages for a lead |
| Create pricing package | Add a pricing package to a lead |
| Get pricing package | Retrieve a single pricing package |
| Update pricing package | Update a lead pricing package |
| Delete pricing package | Remove a pricing package from a lead |
Pricing rules
| Endpoint | Description |
|---|---|
| List pricing rules | Retrieve all pricing rules for a lead |
| Create pricing rule | Add a pricing rule to a lead |
| Get pricing rule | Retrieve a single pricing rule |
| Update pricing rule | Update a lead pricing rule |
| Delete pricing rule | Remove a pricing rule from a lead |
Equipment models
| Endpoint | Description |
|---|---|
| List equipment models | Retrieve all equipment models for a lead |
| Create equipment model | Add an equipment model to a lead |
| Get equipment model | Retrieve a single equipment model |
| Update equipment model | Update a lead equipment model |
| Delete equipment model | Remove an equipment model from a lead |
Equipment orders
| Endpoint | Description |
|---|---|
| List equipment orders | Retrieve all equipment orders for a lead |
| Create equipment order | Create a new equipment order for a lead |
| Get equipment order | Retrieve a single equipment order |
| Update equipment order | Update a lead equipment order |
| Delete equipment order | Remove an equipment order from a lead |
| List order items | Retrieve all items in an equipment order |
| Create order item | Add an item to an equipment order |
| Get order item | Retrieve a single order item |
| Update order item | Update an equipment order item |
| Delete order item | Remove an item from an equipment order |
| Create gateway | Add gateway configuration to an equipment order |
| Get gateway | Retrieve the gateway configuration |
| Update gateway | Update the gateway configuration |
| Delete gateway | Remove the gateway configuration |
| Create file build type | Set the file build type for an equipment order |
| Get file build type | Retrieve the file build type |
| Update file build type | Update the file build type |
| Delete file build type | Remove the file build type from an equipment order |
Compliance & validation
| Endpoint | Description |
|---|---|
| Validate completeness | Check all required fields before submission |
| DataX verification | Run a DataX identity verification |
| Equifax credit | Run an Equifax credit report |
| Equifax state ID | Run an Equifax state ID verification |
| GIACT validation | Run a GIACT bank account validation |
| MATCH inquiry | Run a MATCH Pro terminated merchant screening |
| TinCheck | Run a TinCheck tax ID verification |
| List validations | Retrieve all validation records for a lead |
| Get validation | Retrieve a single validation record |
Signing
| Endpoint | Description |
|---|---|
| Create signing session | Create an e-signature session for MPA agreement delivery |
| Verify signing token | Verify a signing session token |
Clear identity verification
| Endpoint | Description |
|---|---|
| Create Clear session | Initiate a Clear identity verification session |
| Get Clear status | Retrieve the result of a Clear verification |
Fast Apply
Streamlined public-facing MPA form flow for lead capture:| Endpoint | Description |
|---|---|
| Update general | Update the general section of a Fast Apply form |
| Update business | Update the business details section |
| Save principals | Save the principals section |
| Create principal | Add a principal via the Fast Apply form |
| Update principal | Update a specific principal via the Fast Apply form |