MerchantE API Docs
POST/jsp/reports/report_api.jsp
Download OpenAPI (this endpoint)JSON|Download OpenAPI (generated)JSON

Generate Report

Generate Report

Universal endpoint for generating all MerchantE reports. The dsReportId parameter determines which report type is generated. Each report type has its own required and optional parameters.

Report Types by dsReportId

  • 1: Batch Summary Report
  • 2: Settlement Summary Report
  • 3: Deposit Summary Report
  • 5: Chargeback Adjustments Report
  • 7: Retrieval Requests Report
  • 8: Daily Interchange Summary Report
  • 9: Custom Queries (requires queryId)
  • 10: FX Batch Summary Report
  • 11: International Chargebacks Report
  • 12: International Retrieval Requests Report
  • 13: FX Interchange Summary Report
  • 14: International Settlement Summary Report
  • 15: Authorization Log Report
  • 21: Payment Gateway Unsettled Transactions Report
  • 22: Payment Gateway Settled Transactions Report
  • 23: Payment Gateway Rejected Transactions Report

Report Versions

Most reports support two versions:

  • Summary (reportType=0): Aggregated totals by card type
  • Detail (reportType=1): Transaction-level data

Authentication

This API uses form-based authentication. Include the following parameters in every request:

  • userId — Your ME web reporting login ID
  • userPass — Your ME web reporting password

Only reports enabled for your user account will be accessible.

Request Body

Content type: application/x-www-form-urlencoded

Required6 fields

Date range and node ID required for most reports. Payment Gateway reports (21-23) use profileId instead of nodeId.

userIdstring
User Login ID for the ME web reporting system
maxLength: 75
userPassstring
User Login Password for the ME web reporting system
maxLength: 30
dsReportIdstringenum
ID of the report the client is requesting:
- 1: Batch Summary
- 2: Settlement Summary
- 3: Deposit Summary
- 5: Chargeback Adjustments
- 7: Retrieval Requests
- 8: Daily Interchange
- 9: Custom Queries
- 10: FX Batch Summary
- 11: International Chargebacks
- 12: International Retrieval Requests
- 13: FX Interchange Summary
- 14: International Settlement Summary
- 15: Authorization Log
- 21: Unsettled Payment Gateway
- 22: Settled Payment Gateway
- 23: Rejected Payment Gateway
reportDateBeginstring
Begin date for the web report. Format should be mm/dd/yyyy.
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10
reportDateEndstring
End date for the web report. Format should be mm/dd/yyyy.
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10
nodeIdstring
Specific hierarchy node (e.g., merchant account number)
pattern: ^\d{12,16}$ · maxLength: 16
Recommended4 fields

reportType=1 for transaction-level details; profileId for Payment Gateway reports; queryId for custom queries; xmlEncoding for XML format

reportTypestringenum
Report type version:
- 0: Summary version (aggregated totals)
- 1: Detail version (transaction-level data)
profileIdstring
Profile ID / Terminal ID for Payment Gateway reports
maxLength: 20
queryIdstringenum
Custom Query ID (only used with dsReportId=9):
- 283: Visa ARDEF Table
- 284: MasterCard ARDEF Table
- 286: Discover ARDEF Data
xmlEncodingstringenum
Send if report should be delivered in XML format:
- 0: XML style with name/value attributes
- 1: XML style with element names
Others10 fields

Optional search and date filter fields for specific report types

searchCriteriastringenum
Search criteria type for Payment Gateway Unsettled report:
- CN: Card number
- IN: Invoice
- TA: Transaction Amount
searchValuestring
Search value corresponding to searchCriteria
encodingstringenum
Download encoding format:
- 0: CSV (default)
- 1: Fixed width
includeTridentTranIdboolean
Allows clients using the API to receive the transaction id in the download file.
If the Client ID is submitted using the ME Payment Gateway, the client ID will
also be provided in the Batch and Settlement Reports.
includePurchaseIdboolean
Allows clients using the API to receive the purchase id in the report.
includeClientRefNumboolean
Allows clients to receive the client reference number in the report.
batchDateFromstring
Batch date range start for Payment Gateway Settled/Rejected reports
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10
batchDateTostring
Batch date range end for Payment Gateway Settled/Rejected reports
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10
fromDatestring
Date range start for Payment Gateway Rejected report
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10
toDatestring
Date range end for Payment Gateway Rejected report
pattern: ^\d{2}/\d{2}/\d{4}$ · maxLength: 10

Available Reports

Report IDReport NameDescription
1Batch SummaryPre-settlement card totals by date and batch
2Settlement SummarySettled transactions to merchant's bank
3Deposit SummaryACH entries to merchant's account
5Chargeback AdjustmentsIndividual chargebacks with status
7Retrieval RequestsRetrieval request tracking
8Daily InterchangeInterchange qualification categories
9Custom QueriesVisa/MC/Discover ARDEF tables
10FX Batch SummaryInternational FX transactions
12International Retrieval RequestsInternational retrieval tracking
13FX Interchange SummaryFX interchange rates
14International Settlement SummarySettled international transactions
15Authorization LogReal-time authorization attempts
21Payment Gateway UnsettledPending settlement transactions
22Payment Gateway SettledSettled gateway transactions
23Payment Gateway RejectedDeclined transactions

Example Request (Batch Summary Detail)

userId=YOUR_USER_ID&userPass=YOUR_PASSWORD&dsReportId=1&reportDateBegin=04/06/2024&reportDateEnd=04/09/2024&nodeId=941000123456&reportType=1&includeTridentTranId=true&includePurchaseId=true

Responses

200
Successful report generation

Successful report generation

Example Response (CSV)

"Merchant Id","DBA Name","Term Num","Batch Num","Batch Date","Tran Date","Card Type","Card Number","Reference","Purchase Id","Client Reference","Auth Code","Entry Mode","Tran Amount","Digital Wallet"
941000060005,"PAUL'S TEST ACCOUNT","1",765,05/03/2023,04/20/2023,"AM","341111xxxxxx1000","'3891738407","3891738407","","000000","KEYED",56.0,"APPLE"
400
Bad Request - Invalid parameters

Bad Request - Invalid parameters

401
Unauthorized - Invalid credentials

Unauthorized - Invalid credentials

403
Forbidden - User does not have access to requested report

Forbidden - User does not have access to requested report

Response Formats

CSV (Default)

Reports are returned in CSV format by default, with a header row containing column names.

XML

Use the xmlEncoding parameter to receive XML output:

  • xmlEncoding=0 — Name/value attribute style
  • xmlEncoding=1 — Element name style
API Information

Version: 4.3

Servers:

  • https://test.merchante-solutions.com — Test Server

Contact: MerchantE Support — https://www.merchante.com

Code samples

Copy-paste ready code in your preferred language.

API call

Copy/paste friendly
curl -X POST "https://test.merchante-solutions.com/jsp/reports/report_api.jsp" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "userId=YOUR_USER_ID" \
  --data-urlencode "userPass=YOUR_PASSWORD" \
  --data-urlencode "dsReportId=1" \
  --data-urlencode "reportDateBegin=04/06/2024" \
  --data-urlencode "reportDateEnd=04/09/2024" \
  --data-urlencode "nodeId=941000123456" \
  --data-urlencode "reportType=1" \
  --data-urlencode "includeTridentTranId=true" \
  --data-urlencode "includePurchaseId=true"