An ACH/eCheck Query operation retrieves transaction records related to ACH/eCheck activity, including the ability to review possible customer banking changes. It supports querying by order ID or date range.
Transaction Administration - Query Transaction - ACH/eCheck
Overview
The ACH/eCheck Query Transaction operation retrieves transaction records related to ACH/eCheck activity, including the ability to review possible customer banking changes. It supports querying by order ID or date range.
Request Parameters
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description | Notes |
|---|---|---|---|---|---|---|
publisher-name |
Mandatory | string | N/A | Example: gatewayuser |
Gateway account username issued to you. | |
publisher-password |
Mandatory | string | N/A | Example: securepassword |
Remote Client Password used for API authentication. | This differs from the administrative login password. |
mode |
Mandatory | string | N/A | query_noc |
Specifies ACH/eCheck query operation. | Must be set to query_noc. |
orderID |
Optional | string | 20 | Example: 1234567890 |
Transaction identifier to query. | Used for single-transaction lookups. |
startdate |
Optional | string | 8 | 20240101 |
Start date for query range. | Format: YYYYMMDD. Defaults to last 2 days if omitted. Maximum range is 90 days. |
enddate |
Optional | string | 8 | 20240131 |
End date for query range. | Format: YYYYMMDD. |
Response Parameters
| Variable | Value | Description | Notes |
|---|---|---|---|
FinalStatus |
success, problem |
Indicates whether the query succeeded. | Returns problem on failure. |
MErrMsg |
string | Error message returned when no records are found or request fails. | Example: “No records found.” |
Transaction Record Response (aXXXXX)
Each matching record is returned as a URL-encoded string in a dynamically numbered field.
| Variable | Value | Description | Notes |
|---|---|---|---|
aXXXXX |
00001–99999 indexed record |
Encoded transaction data payload. | Field order is not fixed. |
Example format:
trans_date=data&
operation=data&
FinalStatus=data&
card-amount=data&
card-name=data&
card-address1=data&
card-city=data&
card-state=data&
card-zip=data&
card-country=data&
card-number=data&
card-exp=data&
result=data&
MErrMsg=data&
acct_code=data&
acct_code2=data&
acct_code3=data&
acct_code4=data&
auth-code=data&
avs-code=data