APIs


Integrations

ACH

Report API


This API is responsible for generating transaction reports.

This table describes the request parameters for Report API.
Variable NameDescriptionRequiredExpected Value
usernameTCB Pay Gateway UsernameYTCB Pay Gateway Username
api_keyTCB Pay Gateway API KeyYTCB Pay Gateway API Key
start_dateFrom transaction dateYdate format YYYY-MM-DD
end_dateTo transaction dateYdate format YYYY-MM-DD
transaction_typeType of transactionN(default all transaction) SALE,AUTHORIZE,CAPTURE,REFUND,VOID,CREDIT
transaction_statusStatus of transactionN(default all transaction) SUCCESS,FAIL
transaction_idTCBPay ID of the transaction, If we need to know the details of a specific transactionN100000000000001605
page_noPage number of the entire result set. Each page has a maximum of 100 records listedN(default 1) can be up to total page number
reference_idTransaction reference idNReference ID should be unique

Example

Copied
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TCB Pay ACH API Report Test</title>
</head>
<body>
<form name="" action="https://gateway2.tcbpay.com/apis/ach_report.php"
method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="start_date" value="2019-04-01"/>
<input type="text" name="end_date" value="2019-04-15"/>
<br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>

Response:


The response of the API Call is a JSON array. For Error, two elements are returned, code and description. For Successful transactions, three additional elements are returned along with code and description which are no_of_transactions, total_pages, current_page, and an array of transactions. The response code is always 00 for a successful API call.

Sample Response :
Copied
{
  "response": {
    "code": "00",
    "description": "success",
    "no_of_transactions": "1",
    "total_pages": 1,
    "current_page": "1",
    "transactions": [
      {
        "transaction_id": "A9169",
        "parent_transaction_id": "",
        "transaction_type": "SALE",
        "transaction_source": "Moto",
        "initiated_by": "api_user (goutam@mailinator.com)",
        "transaction_status": "INACTIVE",
        "decline_reason": "",
        "transaction_time": "2025-01-30 07:20:49",
        "time_zone": "America/New_York",
        "gmt_time": "2025-01-30 12:20:49",
        "account_no": "********2222",
        "routing_no": "********0025",
        "account_type": "Checking",
        "auth_response_code": "Success",
        "error_response": "",
        "currency": "USD",
        "total_amount": "8.88",
        "amount": "8.88",
        "surcharge": "0",
        "tax": "0",
        "tip": "0",
        "first_name": "Grk",
        "last_name": "Karm",
        "company_name": "",
        "address_1": "555 West 5th Avenue",
        "address_2": "bill 2nd",
        "city": "Columbus",
        "state": "OH",
        "zip_code": "43201",
        "email": "goutam@tcbpay.com",
        "phone_no": "+19999999999",
        "subscription_id": null,
        "ship_first_name": "Grk",
        "ship_last_name": "Karm",
        "ship_company_name": "",
        "ship_address_1": "555 West 5th Avenue",
        "ship_address_2": "bill 2nd",
        "ship_city": "Columbus",
        "ship_state": "OH",
        "ship_zip_code": "43201",
        "ship_phone_no": "+19999999999",
        "is_risk_hold": "NO",
        "IP": null,
        "reference_id": null
      }
    ]
  }
}
Error Codes
Error CodeDescription
01Merchant Information is Missing
02Transaction Currency is missing
03Account Number is missing or Invalid
04Routing Number is missing or invalid
05Check Number is missing or invalid
06Invalid Amount
07Account Type is Missing
08Proper Zip code is missing
09Proper Customer Email Id is missing
10Invalid Processor
11Requested Currency is not allowed for this merchant
12Invalid Merchant Information
13Invalid Country Code
14Sale Volume exceeded for this Merchant
15Monthly Volume exceeded for this Merchant
16Transaction limit exceeded for this Merchant
17IP-wise transaction limit exceeded for this Merchant
18Bank Name is missing
19Transaction Start Date is missing or invalid
20Transaction End Date is missing or invalid
P1Invalid page number
A1Transaction entry failed
We use cookies to offer you a better experience, and analyze site traffic.
By continuing to use this website, you consent to the use of cookies in accordance with our Cookies Policy.