ACH

Queries related to ACH (Automated Clearing House) transactions

Query ACH transactions

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

QuerystringOptional

A query string for obtaining specific transaction records using Number's query language. Build logical terms and join them with '&&' for logical AND or '||' for logical OR. Use single quotes for text and date values. Refer to the variable chart for query composition:

• A: MERCHANT ID - The merchant record you are interested in, e.g. (A=1).
• B: TRANSACTION STATUS - The status of the transaction, e.g. (B=1).
  • -1: ALL
  • 1: OPEN
  • 2: SETTLED
  • 3: FAILED
  • 4: RETURNED
  • 5: VOID
• C: DATE CREATED - The date the transaction was created, e.g. (C>='7/5/2024 12:00:00 AM').
• D: LAST NAME - Last name of the account holder, e.g. (D LIKE '%MITH') for all names that end with 'MITH'.
• E: TRANSACTION LOCK - Lock status of the transaction, e.g. (E<>'0') for locked transactions.
• H: TRANSACTION ID - The unique identifier for the transaction, e.g. (H=58258).
• J: FIRST NAME - First name of the account holder, e.g. (J LIKE 'ROB%') for all names that start with 'ROB'.
• K: TRANSACTION TYPE - The type of transaction, e.g. (K=-1).
  • -1: ALL
  • 1: ACHDEBIT
  • 2: ACHCREDIT
• L: AMOUNT - The $ amount of the transaction, e.g. (L>100.00).
• M: CLIENT REFERENCE ID - User-defined value on the transaction.
• N: RPGUID - User-defined value on the transaction.
• P: CONSENT ID - The Consent ID of card on file the transactions were charged against, e.g. (P=15875).
• Q: ACCOUNT NUMBER LAST 4 - The last 4 digits of a credit card, e.g. (Q='4123').
• R: APPROVAL CODE - The approval code for the transaction, e.g. (R='TAS626').
• S: CUSTOMER LAST NAME - The last name of the customer, e.g. (S='SMITH').
• T: CUSTOMER FIRST NAME - The first name of the customer, e.g. (T='FOSTER').
• U: ORIGIN - The origin of the transaction, e.g. (U='API').
  • "API": REST / SOAP API
  • "WID": Widget
  • "VT": Virtual Terminal

Example: (B=3)&&(E=1)&&(C>'2024-09-01')

Responses

200

Successfully returned ACH transaction records

application/json

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/ACHTransaction HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 20

{
  "Query": "(H=1405)"
}

200

Successfully returned ACH transaction records

{
  "ACHTransaction_QueryResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumRecords": 1,
    "RespMsg": "Successfully Returned Transaction Records : 1",
    "Transactions": [
      {
        "AcctHolderID": 1127,
        "AcctLast4": "0277",
        "AcctType": "PersonalChecking",
        "Amt": 30.5,
        "AuthID": "69019079",
        "BatchLogID": 0,
        "BatchNO": 112,
        "BatchStatus": "N",
        "ChangedBy": null,
        "ChangedOn": "2024-12-01 11:19:01",
        "ConsentID": 0,
        "CreatedBy": "Token 37564",
        "CreatedOn": "2024-12-01 11:19:01",
        "Credits": 0,
        "CustName": "APIACH Sally",
        "EndCustID": 35348,
        "FirstName": "Sally",
        "ID": 1405,
        "LastName": "APIACH",
        "MerchID": 1,
        "Origin": "API       ",
        "REF_ID": "A97689#",
        "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
        "RefTxID": 0,
        "ResolvedOn": "2024-12-01 11:19:01",
        "ReturnReason": "",
        "SettledOn": "2024-12-01 11:19:01",
        "TXN_DATETIME": "2024-12-01 11:19:01",
        "TXstamp": "20240703",
        "TxSTATUS": "OPEN",
        "TxType": "ACHDEBIT",
        "UniqueID": "167901CDE082BC57",
        "UserID": 0,
        "ValMsg": "Success"
      }
    ]
  }
}