API Overview

eCheck Merchant Guide
- Recent Revisions to This Document

Introduction to the eCheck Service
- Requirements for Using the eCheck Service
- eCheck Transaction Types

Getting Started with the eCheck Service
- eCheck Application
  - Submitting the eCheck Application
  - Completing eCheck Application Fields
- Boarding Your Merchant Account for Sandbox Testing

Overview of eCheck Transaction Processing
- eCheck Settlement
  - eCheck Returns
  - eCheck Chargebacks
  - eCheck Credits and Refunds
- eCheck Transaction Statuses During Processing
- eCheck Integrations
- eCheck Risk Reserve
- eCheck Processing Limits and Settings
- eCheck Notice of Change
- Payment Authorization and Authentication for eCheck Transactions
- eCheck Records Retention Requirements

Manage eCheck Settings in the Business Center
- Managing Merchant Permissions in the Business Center
  - Creating Roles
  - Creating a User Account and Adding Roles
- Accessing eCheck Settings in the Business Center
  - eCheck Statements
    - eCheck Settlement Account Statements
    - eCheck Reserve Account Statements

Process eCheck Transactions Using the Business Center
- Submitting Transactions Using the Virtual Terminal
  - Configuring the Virtual Terminal to Process eCheck Transactions
  - Processing eCheck Transactions Using the Virtual Terminal
- Submitting Transactions Using Recurring Billing and Token Management Service
  - Creating an eCheck Recurring Subscription
  - Requesting an On-Demand Transaction
- eCheck Transaction Search and Details

Process eCheck Transactions Using the REST API
- Processing an eCheck Debit Transaction Using the REST API
  - Required Fields for an eCheck Debit Transaction
  - Optional Fields for an eCheck Debit Transaction
  - REST Example: eCheck Debit Transaction
- Processing a Recurring eCheck Debit Transaction Using the REST API
  - Required Fields for a Recurring eCheck Debit Transaction
  - REST Example: Recurring eCheck Debit Transaction
- Creating an eCheck Token Using the REST API
  - Required Fields for Creating an eCheck Token
  - REST Example: Creating an eCheck Token
- Creating an eCheck Token and Processing an eCheck Transaction Using the REST API
  - Required Fields for Creating an eCheck Token and Processing an eCheck Transaction
  - Optional Fields for Creating an eCheck Token and Processing an eCheck Transaction
  - REST Example: Creating an eCheck Token and Processing an eCheck Transaction
- Using an eCheck Token to Submit an eCheck Debit Transaction Using the REST API
  - Required Fields for Using an eCheck Token to Submit an eCheck Debit Transaction
  - Optional Fields for Using an eCheck Token to Submit an eCheck Debit Transaction
  - REST Example: Using an eCheck Token to Submit an eCheck Debit Transaction

Accepting eCheck Payments through Unified Checkout, Pay by Link, and Invoicing
- Accepting eCheck Payments through Unified Checkout
- Accepting eCheck Payments through Invoices
- Accepting eCheck Payments through Payment Links

eCheck Reconciliation Reports
- Funding Details Report
  - Fields in the Funding Details Report
- Chargeback Details Report
  - Fields in the Chargeback Details Report
- Deposit Details Report
  - Deposit Details Report Line Items
  - Fields in the Deposit Details Report

eCheck Reconciliation Reporting Case Study
- Day 1
- Day 2
- Day 3
- Day 4
- Day 5
- Day 6
- Day 7
- Day 8

On This Page

Required Fields for a Recurring eCheck Debit Transaction

clientReferenceInformation.code
orderInformation.amountDetails.currency: Value must be set to
USD
.
orderInformation.amountDetails. totalAmount: This field is required if you do not submit
orderInformation.lineItems[].unitPrice
and
orderInformation.lineItems[].quantity
.
orderInformation.billTo. address1
orderInformation.billTo.administrativeArea: Set the value to a valid USPS two-letter state or possession abbreviation.
orderInformation.billTo. country: Set the value to
US
.
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.locality
orderInformation.billTo.phoneNumber
orderInformation.billTo.postalCode
paymentInformation.bank.account.number
paymentInformation.bank.account.type
paymentInformation.bank.routingNumber
paymentInformation.paymentType.name: Set the value to
check
.
processingInformation.commerceIndicator: Set the value to
recurring
.
processingInformation.recurringOptions. firstRecurringPayment: If this is the first payment in the recurring series of payments, set the value to
true
. For each subsequent payment in the series, set the value to
false
.

Back to top