ACH Reports
Default available set of reports
Daily Account Statement
Provides transaction details for a specific day and the amount that will be deposited into the merchants bank
account
DailyAccountStatement
If you pass in EffDate of 1900-01-01 you will trigger the test response. This is useful for testing, if you have a new merchant with no data, we will return a sample set of data to you.
OrigComp:
The merchant number provided by CheckCommerce that uniquely identifies the merchant.
Effective Date:
The date the transaction is effective. This is typically the business day following today’s date.
Todays Date:
The date the report is being requested.
Example CGI querystring request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=HTML&ReportPermDesc=DailyAccountStatement&Parameter_Orig
Comp=999011&Parameter_TodaysDate=2017-07-27&Parameter_EffDate=2017-07-
28&ReportXSLTPermDesc=DailyAccountStatement
Example using SDKstring token = Token.GetToken("999011", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]{
new D.ReportDefinition.Parameter { PermDesc = "OrigComp", ParamValue = "999011" },
new D.ReportDefinition.Parameter { PermDesc = "TodaysDate", ParamValue = "2017-07-27" },
new D.ReportDefinition.Parameter { PermDesc = "EffDate", ParamValue = "2017-07-28" }};
//Run report
Response resp = GetReport.RunReport(token, "DailyAccountStatement", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Daily Summary Statement
Provides a listing of transactions Originated and Settled for a specific day. This is also a daily emailed report. You can use this in the Active Reports to pull your data directly. You can get the direct data or the report in HTML format for display in a web browser.
DailySummary
If you pass in EffDate of 1900-01-01 you will trigger the test response. This is useful for testing, if you have a new merchant with no data, we will return a sample set of data to you.
CoNo:
The merchant number provided by CheckCommerce that uniquely identifies the merchant.
Effective Date:
The date the transaction is effective. This is typically the business day following today’s date.
Todays Date:
The date the report is being requested.
Example CGI querystring request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=HTML&ReportPermDesc=DailySummary&Parameter_CoNo=999011&Parameter_TodaysDate=2017-07-27&Parameter_EffDate=2017-07-28&ReportXSLTPermDesc=DailySummary
Example using SDKstring token = Token.GetToken("999011", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]{
new D.ReportDefinition.Parameter { PermDesc = "CoNo", ParamValue = "999011" },
new D.ReportDefinition.Parameter { PermDesc = "TodaysDate", ParamValue = "2017-07-27" },
new D.ReportDefinition.Parameter { PermDesc = "EffDate", ParamValue = "2017-07-28" }};
//Run report
Response resp = GetReport.RunReport(token, "DailySummary", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Status and Remittance Snapshot
Provides a snapshot of the prior days transactions and can be run for a specific merchant, an aggregator or a reseller. Optionally the report can be run by either effective entry date, remittance date or settle date.
StatusRemittanceSnapshot
In order for this report to be used the merchant must be configured to generate the snapshot of the data. This snapshot is generated after 9:00 PM MST and before Midnight MST. It is available for use after midnight each night.
\ \
The merchant number provided by Check Commerce that uniquely identifies the merchant.\
The master aggregator MID for accounts that have children merchants\
The reseller code for accounts that are resellers.
\
The date the transaction is effective.\
The date remittance was sent for the transaction.\
The date the transaction settled.
Example CGI querystring request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=HTML&ReportPermDesc=StatusRemittanceSnapshot&Parameter_MID=999011&Parameter_EED=2017-07-27&ReportXSLTPermDesc=StatusRemittanceSnapshot
Example SDKstring token = Token.GetToken("999011", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]{
new D.ReportDefinition.Parameter { PermDesc = "MID", ParamValue = "999011" },
new D.ReportDefinition.Parameter { PermDesc = "EED", ParamValue = "2017-07-27" }};
//Run report
Response resp = GetReport.RunReport(token, "StatusRemittanceSnapshot", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Merchant Invoice
Detailed listing of fees for services provided by CheckCommerce for a specific month
Merchant_Invoice\
CoNo:
The merchant number provided by CheckCommerce that uniquely identifies the merchant.
Month:
Two digit month
Year:
Four digit year
Example CGI querystring request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=HTML&ReportPermDesc=Merchant_Invoice&Parameter_Month=02& Parameter_Year=2017-07-27&Parameter_Cono=999011&ReportXSLTPermDesc=Merchant_Invoice
Example SDK//Get token
string token = Token.GetToken("999011", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]{
new D.ReportDefinition.Parameter { PermDesc = "CoNo", ParamValue = "999011" },
new D.ReportDefinition.Parameter { PermDesc = "Month", ParamValue = "02" },
new D.ReportDefinition.Parameter { PermDesc = "Year", ParamValue = "2017" }};
//Run report
Response resp = GetReport.RunReport(token, "Merchant_Invoice", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Reseller Quarterly Business Report
Summarizes a reseller’s activity over a period of time. Providing statistics about the overall portfolio of
merchants. This report is pre-calculated once a month. You may not have a pre-calculated version available to you depending on the setup of your merchant.
ResellerQuarterlyBusinessReport
ResellerCode:
The merchant reseller code provided by CheckCommerce that uniquely identifies the reseller.
Start Date:
10 digit date i.e. 2017-01-01
End Date:
10 digit date i.e. 2017-01-01
Example CGI query string request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=XML&ReportPermDesc=ResellerQuarterlyBusinessReport&Param
eter_start_dt=2017-11-01&Parameter_end_dt=2017-12-01&Parameter_ResellerCode=R999040
Example SDK//Get token
string token = Token.GetToken("999040", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]
{
new D.ReportDefinition.Parameter { PermDesc = "CoNo", ParamValue = "R999040" },
new D.ReportDefinition.Parameter { PermDesc = "start_dt", ParamValue = "2017-01-01" },
new D.ReportDefinition.Parameter { PermDesc = "end_dt", ParamValue = "2017-04-01" }};
//Run report
Response resp = GetReport.RunReport(token, "ResellerQuarterlyBusinessReport", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Reseller Information
Provides basic reseller information if the merchant is a Reseller
ResellerInformation
Company:
The merchant code provided by CheckCommerce that uniquely identifies the reseller.
Example CGI querystring request using the GET methodhttps://test.checkgateway.com/EpnAPI/ActiveReports/GetReport.aspx?&Token=YOURTOKEN
&Action=Report&OutputType=XML&ReportPermDesc=ResellerInformation&Parameter_Company
=999030
SDK Examplestring token = Token.GetToken("999030", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]
{
new D.ReportDefinition.Parameter { PermDesc = "Company", ParamValue = "999030" }
};
//Run report
Response resp = GetReport.RunReport(token, "ResellerInformation", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Merchant Information
Provides basic merchant information including merchant name, merchant number, banking information, daily cutoff times and parent account information if applicable.
MerchantInformation
MID:
The merchant code provided by CheckCommerce that uniquely identifies the reseller.
Example CGI querystring request using the GET method
SDK Examplestring token = Token.GetToken("999011", "demoacct");
Console.WriteLine(token);
//View available reports
D.ReportDefinition[] reports = Manage.ReportList(token,
D.ReportDefinition.OutputType.JSON.ToString());
foreach (D.ReportDefinition report in reports)
{
Console.WriteLine(report.ToString());
}
//Set parameters for report
D.ReportDefinition.Parameter[] reportParams = new D.ReportDefinition.Parameter[]
{
new D.ReportDefinition.Parameter { PermDesc = "MID", ParamValue = "999011" }
};
//Run report
Response resp = GetReport.RunReport(token, "MerchantInformation", reportParams,
D.ReportDefinition.OutputType.HTML);
Console.WriteLine(resp.I.SData);
Updated 12 months ago