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

Transaction (Quest) APIs

PreviousMerchant Onboarding APIsNextAutomated Merchant Onboarding Setup API

Last updated 28 days ago

Was this helpful?

The are RESTful APIs that provides flexibility and control over payment processing. Use it to integrate payments into your point-of-sale (POS) system while reducing PCI scope and enhancing security with tokenization. It also supports in-person payments with encrypted card readers.

ACH

ACH Mobile Transactions

  • POST: Credit Transaction

  • POST: Debit Transaction

ACH Provider

  • GET: Get Paya Ach Provider By SecCode

  • GET: Get All Ach Providers For Specific Terminal

ACH Transactions

  • GET: Search for ACH Transactions

  • POST: Post Transaction

  • POST: Post a Credit Transaction

  • POST: Post a Debit Transaction

  • POST: Reversal Transaction

  • POST: Validate ACH Account

  • GET: Get Transaction

  • DELETE: Void Transaction

ACH Vault

  • POST: Create an ACH token

  • GET: Get ACH Token

  • PUT: Update ACH Token

  • DELETE: Delete ACH Token

Android Device Configuration

Android Device Configuration

  • GET: Get Android Device

Batches

Batches

  • GET: Get open batch

  • PUT: Close open batch

Batches Warehouse

  • GET: Get all batches

Gateway Settings

RPS Settings

  • GET: Get RPS Settings

  • POST: Update RPS Settings

  • PUT: Update RPS Settings

HPP Settings

  • GET: Get HPP Settings

  • POST: Create HPP Settings

  • PUT: Update HPP Settings

  • DELETE: Delete HPP Settings

PayLink Settings

  • GET: Get PayLink Settings

  • POST: Create PayLink Settings

  • PUT: Update PayLink Settings

  • DELETE: Delete PayLink Settings

Terminal Settings

  • GET: Get Terminal Settings

  • PUT: Update Terminal Settings

AVS Settings

  • GET: Get AVS Settings

  • PUT: Update AVS Settings

Check Duplicate Transaction Settings

  • GET: getSettings

  • POST: createSetting

  • PUT: updateSetting

CSC Settings

  • GET: Get CSC Settings

  • PUT: Update CSC Settings

Device Settings

  • GET: Get Device Settings

  • POST: Update(?) Device Settings

  • PUT: Update Device Settings

  • DELETE: Delete Device Settings

Transaction Alert Controller

  • GET: getSettings

  • POST: createSetting

  • DELETE: deleteSetting

Report Settings

  • GET: Get Report Settings

  • POST: Update(?) Report Settings

  • PUT: Update Report Settings

HPP Signature Verification Service

HPP Signature Verification Service

POST: Verify HPP Response

Mobile Transactions Using SDKs

Mobile Transactions using SDKs

  • POST: Authorization Transaction

  • POST: Forced Sale Transaction

  • POST: Refund Transaction

  • POST: Sale Transaction

Receipt Service

Receipt Service

  • POST: Post a receipt request

Recurring Payments API

Customer

  • GET: Search Customers

  • POST: Create a Customer

  • GET: Get a Customer's Info

  • PUT: Update a Customer

  • DELETE: Delete a Customer

Customer Token

  • GET: Get Tokens for a Customer

  • POST: Add an existing token to a customer

  • PUT: Update a Token

Customer Token Delete

  • DELETE: Delete a Token

Forecast

  • GET: Get a Plan Forecast

Payment Plans

  • GET: Search Plans

  • POST: Create a Plan

  • GET: Get a Plan's Info

  • PUT: Update a Plan

  • GET: Get a Plan's Expected Runs

  • DELETE: Delete a Plan

Search Payment Transaction

  • GET: Search Payments

Semi-Integrated API Batches (Transaction EMV Batches)

Semi-Integrated Batches

  • PUT: Close open batch

Basic Error Controller

  • GET/error errorHtml

  • HEAD/error errorHtml

  • POST/error errorHtml

  • PUT/error errorHtml

  • DELETE/error errorHtml

  • OPTIONS/error errorHtml

  • PATCH/error errorHtml

Semi-Integrated API Transactions (Transaction EMV)

Transaction EMV

  • POST: Post Transaction

  • POST: Authorization

  • POST: Forced Sale

  • POST: Refund

  • POST: Sale

  • POST: Token Only

Transaction Signature Service

Transaction Signature Service

  • POST: Post a transaction signature

  • GET: Get a transaction signature

Transactions (Gateway Proxy)

  • GET: Search Transactions

  • POST: Authorization Transaction

  • POST: Capture Transaction

  • POST: Forced Sale Transaction

  • POST: Refund Transaction

  • POST: Sale Transaction

  • POST: Void Transaction

  • PUT: Adjust Tip

Vault API (Token Controller)

Token Controller

  • GET: Search Tokens

  • POST: Create a token

  • GET: Get Token

  • DELETE: Delete Token

  • PUT: Update a token

Transaction (
Quest
) APIs