LogoLogo
API ReferencesGithubSupport CenterStatus pageBecome a Partner
  • Getting Started
    • Welcome
    • Our Products
  • Integration Process
  • Devices
    • Dejavoo
    • PAX
    • ID TECH
  • Become a Partner
  • Developer Resources
    • Overview
    • Sandbox & Production Environments
  • Testing Integration
    • Test Cards & ACH Accounts
    • Onboarding API Result Codes
    • Transaction Error Generation Data
    • Card Response & Result Codes
      • Card Error Response Codes
      • Card Transaction Result Codes
      • CSC Response Codes
      • AVS Response Codes
      • Duplicate Transaction Settings
    • ACH Request Validation & Return Codes
      • ACH Request Validation Codes
      • ACH Return Codes
  • API Catalog
    • Merchant Onboarding APIs
    • Transaction (Quest) APIs
    • Automated Merchant Onboarding Setup API
    • Reporting API
  • Webhooks
    • Prerequisites
    • Transaction Webhook
    • Onboarding Webhooks
      • Application Status
      • Application Fixes
      • Equipment Tracking & Activation
        • Equipment Tracking
        • Equipment Activation
  • Merchant Onboarding
    • Overview
  • Automated Merchant Onboarding
    • Prerequisites
    • Working with Automated Merchant Onboarding
      • Generating a Merchant Application
      • Completing the Application
      • Modifying Default Merchant Pricing
        • Retrieving Existing Pricing Templates
        • Modifying Pricing Fees & Completing Merchant Application Record
    • Merchant Onboarding Status Webhooks
    • Configuring Automated Merchant Onboarding
  • Merchant Onboarding via Partner Portal
    • Starting New Application
    • Adding Hierarchy & Compensation Details
    • Entering Business Information
    • Entering Profile Details
    • Conducting the Site Survey
    • Configuring Pricing Details
    • Adding Banking Information
    • Adding Equipment
    • Submitting Signature
    • Reviewing & Submitting Application
    • Viewing Application Summary
  • Merchant Onboarding via API
    • Prerequisites
    • Understanding Integration
    • Working with Merchant Onboarding API
      • Creating a Merchant Profile
      • Completing the Merchant Application
        • Gathering Merchant Demographics
        • Configuring Merchant Pricing
        • Ordering and Setting Up Equipment
      • Submitting the Signature
      • Submitting the Application
  • Payment Processing Solutions
    • Overview
    • Cloud EMV
      • Working with Cloud EMV
        • Direct Data Transfer to Clearent's Cloud
        • Payment Authorization Process via Clearent's Quest Payment Gateway
    • JavaScript SDK
      • Prerequisites
        • Browser Support
      • Working with JavaScript SDK
        • Adding the Payment Form
        • Formatting the Payment Form
        • Processing the Payment
        • Using Apple Pay for Web
        • Using Google Pay for Web
        • Using IDTech VP8300
      • Card Validations
        • Card Number Validation
        • Card Expiration Date Validation
        • Card CSC/CVC Validation
      • Configuring with JavaScript SDK
        • Using Members
        • Using Methods
  • Hosted Payments
    • Prerequisites
      • Browser Support
    • Working with Hosted Payments
      • Configuring the Pay Now Button
      • Configuring Payment Page with an Amount Field
      • Configuring Payment Page with an Optional Billing Address and Headline Text
      • Configuring Payment Page with the Save Card Option
      • Configuring the Add Payment Method Button
      • Styling Your Brand on the Payment Page
      • Configuring Apple Pay for Web
      • Configuring Hosted Payment Page Using Members
      • Configuring Hosted Payment Page Using Methods
      • Configuring Hosted Payment Page Using Functions
    • Transaction Responses
      • Successful Transaction Response
      • Successful Transaction Response for a Billing Address
      • Failed Transaction Response
      • Unauthorized Request Response
      • Successful Transaction Response for a Token
      • Successful Token Request Response
    • Response Validations
      • Successful Transaction Response Validation
      • Failed Transaction Response Validation
    • Card Validations
  • Mobile EMV SDK
    • Working with Mobile Card Reader
    • Working with iOS Framework for IDTech VP3300
      • Processing Payments for iOS Applications
        • Pairing the VP3300 Card Reader with Your iOS Phone or Tablet
        • Charging the VP3300 Card Reader
        • Reading the Card Data Using the IDTech VP3300
        • Clearent's iOS Framework for IDTech VP3300 - Pre-requisites
        • Clearent's iOS Framework for IDTech VP3300 - Additional Configuration
        • Adding Clearent's iOS Framework into your iOS Application
        • Setting Up Clearent's iOS Framework for your Objective-C iOS App
        • Starting a Transaction using Clearent's iOS Framework
        • Starting a Connection using Clearent's iOS Framework
        • Starting a Connection using Clearent's iOS Framework
        • Receiving Feedback Messages using Clearent's iOS Framework
    • Working with Android Framework for IDTech VP3300
      • Configuring an Android Framework for your App
      • Additional Configuration to your Android App
      • Generating a Transaction Token for Manual card Entry
      • Disabling Default EMV Configuration for the Card Reader
      • Configuring Experience with Clearent's Android Framework
  • ACH Transaction Integration
    • Integration Methods for the ACH Transactions
    • Processing an ACH Transaction
    • Getting an ACH Transaction
    • Creating an ACH Transaction Token
    • Handling Returns for the ACH Transactions
    • Checking an ACH Transaction Status
    • ACH Transaction Statuses
    • ACH Transaction Return Codes
  • Paylink
    • The Paylink URL
    • Working with the Paylink
      • Setting up the Paylink
      • Configuring the Paylink URL
      • Using the Paylink Settings API
        • Request Parameters
      • Getting the Paylink Settings
      • Applying the Paylink Settings
      • Sending the Paylink SMS
  • Virtual Terminal
    • Working with the Virtual Terminal
      • Accessing Virtual Terminal
      • Adding or Ordering the Equipment
      • Recurring Payments
        • Adding a New Customer
        • Adding a Payment Method
        • Adding a New Payment Plan
        • Viewing the Plans
      • Processing Sales Transaction
      • Processing ACH Transaction
      • Transaction Search
        • Viewing Transactions
        • Viewing Transaction Receipt
        • Printing Transaction Receipt
        • Emailing Transaction Receipt
        • Void a Transaction
        • Refund a Transaction
        • Processing Pending Transactions
      • Open Batches
        • Viewing Batches
      • VT Settings
        • Merchant
        • Terminal
        • External Terminal
        • Address Verification (AVS)
        • Card Security Code (CSC)
        • Hosted Payment Page (HPP)
  • Financial Management
    • Overview
    • Merchant Pricing
  • Merchant Billing & Funding
  • Financial Reporting
  • Disputes Management
    • Understanding Charge Disputes
    • Managing Disputes in Merchant Portal
    • Managing Disputes via API (Coming Soon!)
  • Reporting
    • Overview
  • Reporting Solutions
  • Working with Reporting API
    • Accessing Reports
    • Retrieving Reports
    • Exporting Reports
  • Support Ticketing
    • Overview
    • Benefits of Support Ticketing System
    • Accessing Support in the Portals
    • Working with Support Ticketing via Partner Portal
      • Types of Support Tickets
      • Submitting a Support Ticket via Partner Portal
  • Working with Support Ticketing via Merchant Portal
    • Types of Support Tickets
    • Submitting a Support Ticket via Merchant Portal
  • Partner & Merchant Solutions
    • Overview
    • Accessing the Portals
    • Navigating the User Interface
    • Working with the Partner Portal
      • Monitoring Performance with Dashboards
      • Managing Merchant Applications
      • Managing Merchants
      • Accessing Reports & Managing Subscriptions
        • Accessing Reports
        • Managing Subscriptions
      • Submitting a Support Ticket
  • Working with the Merchant Portal
    • Monitoring Home Page
    • Accessing Batches
    • Managing Transactions
    • Managing Funding Transactions
    • Managing Virtual Terminal
    • Viewing Chargebacks
    • Managing Disputes
    • Managing Statements & Tax Forms
    • Managing Account Settings
    • Managing User Notifications
    • Managing Support Tickets
  • Security Solutions
    • Overview
    • PCI Compliance
    • Tokenization
    • Encryption
    • Advanced Compliance & Security Measures & Programs
Powered by GitBook

Resources

  • Contact
  • Support Site
  • Campus

Terms & Policies

  • Terms
  • Privacy Policy
  • Disclosures
  • Merchant Agreement

Cookies

  • Cookie List
  • Cookies Settings

Site Info

  • Sitemap

© 2025 Clearent, LLC is a registered agent for Central Bank of St. Louis, MO; Citizens Bank, N.A., Providence, RI; and Pathward, N.A., Sioux Falls, SD.

On this page

Was this helpful?

Export as PDF
  1. Merchant Onboarding via API

Understanding Integration

PreviousPrerequisitesNextWorking with Merchant Onboarding API

Last updated 1 month ago

Was this helpful?

Clearent uses an API-driven workflow to onboard new merchants. This automated process streamlines the workflow from application submission to equipment activation, helping merchants get started quickly.

The following image and step-by-step guide outline the integration flow:

1

Merchant Data Collection

Merchant onboarding begins with Merchant Data Collection, where the integrator collects and submits essential details using the Integrator UI. This interface integrates with Clearent’s backend systems to create and manage merchant profiles.

APIs Used:

  • – Creates the Merchant Identifier (MID) and merchant profile.

  • , , and – Processes equipment details, pricing structures, and merchant demographics.

Once the data is submitted, Clearent’s system validates the provided details and returns responses for verification.

2

Data Validation and Correction

After submitting the application, Clearent validates the data. The notifies the integration system of any required corrections.

Key Validations Include:

  • Business Contact Validation: Verifies business ownership details and information.

  • Bank Validation: Confirms banking details to prevent transaction errors.

These validations ensure that all merchant information is accurate and ready for processing.

To enable corrections based on webhook notifications, we recommend following these steps:

  1. Implement webhook consumption to receive notifications

  2. Display the notifications to merchants in a user-friendly format

  3. Collect the updated data from merchants

  4. Submit the corrected data using the same APIs used during the Merchant Data Collection process

  5. Proceed with the Sign Application and Submit Application steps

Note: Merchants can still proceed even if corrections are not made immediately.

APIs Used:

  • : Updates and validates merchant details, taxpayer data, business contacts, and bank account information.

3

Merchant Agreement and Application Submission

Merchants review their applications, sign agreements electronically, and submit the finalized application. Clearent logs terms, IP addresses, and timestamps to ensure transparency.

  • Electronic Signature Submission: Merchants sign agreements electronically to streamline the process.

    Document Upload Alternative: Pre-signed agreements can also be uploaded for verification.

APIs Used:

  • – Signature Endpoints: Captures electronic signatures.

  • – Submit Signature & Submit Application Endpoints: Finalizes the application for review.

4

Automated Underwriting and Decisioning

Once the application is submitted, Clearent triggers a Webhook URL again to start the underwriting process. The Automated Underwriting system evaluates the merchant’s risk and compliance. There are three possible outcomes:

  • Approval: The merchant passes underwriting and moves to the equipment setup phase.

  • Manual Review: Additional verification may be required, such as further documentation or business validation.

  • Decline: The application is rejected if the merchant does not meet compliance or risk thresholds.

The merchant receives real-time updates on their application status via .

5

Equipment Setup and API Key Integration

For approved merchants, Clearent configures the necessary payment hardware and provides API keys for seamless system integration.

Automated Equipment Setup (Quest/TSYS):

  • Configures merchant hardware, such as POS systems and card readers.

  • Assigns API Keys for merchants integrating Clearent’s payment processing system.

Step 5.1: Run Card-Not-Present (CNP) Transactions

From this stage, merchants can begin processing Card-Not-Present (CNP) transactions, such as online, phone, or virtual payments, after their profile is created and data is validated.

Note: CNP transactions don’t require physical equipment. Once data validation and underwriting are complete, merchants can start accepting remote payments.

6

Equipment Shipping and Activation

After approval, equipment is shipped and pre-configured for immediate use. Merchants can activate the equipment and begin in-person transactions.

Stage 6.1: Run Card-Present (CP) Transactions

After receiving and activating equipment, merchants can process Card-Present (CP) transactions in-store using devices like card readers or POS terminals.

Note: CP transactions require functional hardware. Once activated, merchants can immediately start in-person payment processing.

Boarding Management API
Equipment API
Pricing API
Demographics API
Application Fixes Webhook
Demographics API
Demographics API
Boarding Management API
Webhook Notifications