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. API Catalog

Merchant Onboarding APIs

PreviousAPI CatalogNextTransaction (Quest) APIs

Last updated 28 days ago

Was this helpful?

The provide a complete solution for onboarding merchants. It allows integrators to manage the merchant sign-up experience and ensure a smooth process.

Boarding Management API

Merchant Application

  • PUT: Update Properties

  • GET: Get Properties

  • POST: Create Application

  • POST: Default Pricing Plan

  • POST: Submit Signatures

  • POST: Submit Application

Merchant Demographics API

Bank Account

  • GET: Get Bank Account

  • POST: Create Bank Account

  • PUT: Update Bank Accounts

  • DELETE: Delete Bank Accounts

  • PUT: Update Bank Account

  • DELETE: Delete Bank Account

Business Contact

  • GET: Get Business Contact

  • PUT: Update Business Contact

  • DELETE: Delete Business Contact

  • GET: Get Business Contacts

  • POST: Create Business Contact

  • POST: Create Ownership Disclosure

  • PUT: Update Ownership Disclosure

  • GET: Get Ownership Disclosure

Documents

  • GET: Get Voided Checks

  • POST: Upload Voided Checks

  • POST: Upload Voided Checks - Base64Format

  • POST: Upload Voided Checks - MultipleDocuments - Base64Format

  • POST: MultipleDocuments

  • POST: Base64Format

  • POST: Upload Document

  • GET: Get Documents By Category

  • POST: Upload Signed Application - Base64Format

  • POST: Upload Signed Application

  • GET: Get Documents By MerchantNumber

  • GET: Get Documents By DocumentId

  • DELETE: Delete Document

  • DELETE: Delete Voided Checks

  • POST: Update VoidedCheck's bank account number

Merchant:

  • GET: Merchants

  • POST: Creates Merchant

  • GET: Gets Merchant

  • PUT: Updates Merchant

  • DELETE: Deletes Merchant

  • GET: Gets Physical Address

  • PUT: Updates Physical Address

  • GET: Gets Mailing Address

  • PUT: Updates Mailing Addres

References

  • GET: Get Country Codes using Address Type

  • GET: Returns a list of state options

  • GET: Get MCC Codes

  • GET: Get Company Types

  • GET: Get Compensation Types

  • GET: Get Previous Processors

  • GET: Get Businesses Under User

  • GET: Search For Businesses Under User

  • GET: Get Phone Types

  • GET: Get Contact Types

  • GET: Get Relationship Origin Types

  • GET: Get Document Categories

  • GET: Get Signature Sections

  • GET: Get Signature Source Types

  • GET: Get Site Types

  • GET: Get Future Delivery Type

Sales Profile

  • GET: Get SalesProfile - v2.0

  • PUT: Update SalesProfile - v2.0

Site Survey

  • GET: Get Site Survey

  • PUT: Update Site Survey

Tax Payer

  • GET: Get Taxpayer - v2.0

  • PUT: Update Taxpayer - v2.0

Merchant Legal Documents API

Signatures

  • GET: Get Signatures - Legal Documents

  • PUT: Update Signatures - Legal Documents

  • DELETE: Delete Signatures - Legal Documents

  • GET: Get Signatures - Demographics

  • PUT: Update Signatures - Demographics

  • DELETE: Delete Signatures - Demographics

Types

  • GET: Returns Types of Terms and Conditions - Demographics

  • GET: Returns Types of Terms and Conditions - Legal Documents

Terms And Conditions

  • GET: Returns Terms and Conditions applicable to merchant identified by MerchantNumber - Demographics

  • GET: Returns Terms and Conditions applicable to merchant identified by MerchantNumber - Legal Documents

  • GET: Returns Terms and Conditions entry for specified Type ID - Demographics

  • GET: Returns Terms and Conditions entry for specified Type ID - Legal Documents

Pricing Plan API

Pricing Plan V2

  • GET: Returns a pricing plan

  • POST: Creates a pricing plan

  • DELETE: Deletes a pricing plan

  • GET: Returns all pricing plans of the merchant

  • PUT: Updates a pricing plan

  • DELETE: Deletes a pricing plan

  • GET: Templates

  • GET: Eligibility

  • GET: EmpowerAttributes

Reference

  • GET: PayInMonth

  • GET: DisplayTypeCode

Equipment Order API

Equipment Order

  • POST: Post Equipment Order

  • GET: Get a merchant's existing order

  • DELETE: Delete a merchant's existing order

  • GET: Get a merchant's existing order by order id

  • GET: Get a merchant's existing order by merchant and status

Equipment Configuration Survey API

Equipment Configuration Survey

  • GET: Get Equipment Configuration Survey

Equipment Terminal Loader API

Equipment Terminal Loader

  • GET: Get All Products (devices) that match search criteria

  • GET: Get One Product (device)

eDocs Reporting API

eDocs Reporting

  • GET: Get Document from eDocs

  • GET: Get Document Types

  • GET: Get Documents By Type

  • GET: Get Statements by Year

  • GET: Get Statements by Year and Month

Launch Integrator Setup API

Launch Integrator Setup

  • GET: Retrieves a merchant

  • POST: Creates a new merchant

Boarding APIs