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
    • Register Endpoint
    • Webhook Subscriptions
    • Working with Webhooks
      • Transaction Webhook
      • Onboarding Webhooks
        • Application Status
        • Application Fixes
      • Equipment Tracking & Activation Webhooks
        • 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
        • Apple Pay for Web
        • 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
    • VP3300 Mobile Card Reader
      • Charging the card reader
      • Reading the card data
    • iOS Framework
      • iOS Framework Pre-requisites
      • Processing payments in your iOS app
        • Optional settings
        • Starting a Bluetooth connection
        • Pairing the card reader with an iOS device
        • Integrating the iOS framework into your app
        • Setting up the iOS framework in your Objective-C app
        • Starting a transaction in your iOS app
        • Receiving feedback messages
    • Android Framework
      • Integrating the Android framework into your app
      • Additional settings
      • Generating a JSON Web Token
      • Disabling default EMV configuration
  • ACH Transactions
    • Submitting the payment request
    • Creating an ACH token
    • Getting an ACH transaction
    • 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. ACH Transactions

Submitting the payment request

To submit the payment request:

1

Use the POST method with the /rest/v2/ach/transactions endpoint and the following sample request:

{ 
  "check-field": "invoice", 
  "client-ip": "111.22.22.333", 
  "dob-year": "dob-year", 
  "email-receipt": "true", 
  "software-type-version": "1.0", 
  "type": "Debit", 
  "validate-account": "true", 
  "amount": "string", 
  "routing-number": "string", 
  "account-number": "string", 
  "account-type": "Checking", 
  "standard-entry-class-code": "PPD", 
  "check-number": "string", 
  "create-token": "false", 
  "create-description": "false", 
  "individual-name": "string", 
}

The following table describes the request body parameters:

Name
Data type
Required?
Description

check-field

String

Optional

Specifies the field for check identification. For example, invoice.

client-ip

Integer

Optional

The IP address of the client initiating the request. For example, 111.22.22.333

dob-year

Integer

Optional

The customer's year of birth.

email-receipt

Boolean

Optional

Indicates whether to send an email receipt.

software-type-version

Integer

Optional

The version of the specification used to initiate the transaction.

type

String

Optional

The type of ACH transaction.

validate-account

Boolean

Optional

Indicates whether to validate the bank account.

amount

String

Optional

The transaction amount.

routing-number

String

Optional

The bank routing number.

account-number

String

Optional

The bank account number.

account-type

String

Optional

The type of bank account.

standard-entry-class-code

String

Optional

The ACH standard entry class code.

check-number

String

Optional

The check number associated with the transaction.

create-token

Boolean

Optional

Indicates whether to create a reusable token.

create-description

Boolean

Optional

Indicates whether to create a transaction description.

individual-name

String

Optional

The name of the individual associated with the transaction.

The ach-transaction returns the following status and error codes:

Code
Description

401

If the authentication token has expired or the signature does not match the token.

500

If the request is invalid—for example, if the routing number contains letters.

PreviousACH TransactionsNextCreating an ACH token

Last updated 1 day ago

Was this helpful?