Servlet and REST Request Examples
The Download Servlet sends a GET request using the following URL format:
https://<server_name>/reports/servlet/DownloadReport/YYYY/MM/DD/<merchant_ID>/<report_name>.<report_format>
The Query Servlet sends a POST request with search parameters:
https://<server_name>/ebc/Query
The search parameters required for each request are dependent on the servlet function.
REST requests vary by function. For detailed information, see the Reporting REST API, Transaction Detail REST API, and Transaction Search REST API in our Developer Center.
The examples below show the differences between servlet and REST requests for different functions.
|
Function: Report Download [Download] Servlet Request: https://<server_name>/reports/servlet/DownloadReport/YYYY/MM/DD/<merchant_ID>/<report_name>.<report_format> REST Request: https://api.cybersource.com/reporting/v3/report-downloads { "organizationID": "myorg", "reportDate": "2018-05-23", "reportName": "MyReport" } |
|
Function: Single Transaction Query (Transaction Detail in New Business Center) Servlet Request: https://<server_name>/ebc/Query?merchantID=merchant1&requestID=5187901209120179112634&type=transaction&subtype=transactionDetail&versionNumber=1.7 REST Request: https://api.cybersource.com/tss/v2/transactions/{id} |
|
Function: Transaction Search by Merchant Reference Number Servlet Request: https://<server_name>/ebc/Query?merchantID=merchant1&merchantReferenceNumber=1234&targetDate=20180523&type=transaction&subtype=transactionDetail&versionNumber=1.7 REST Request: https://api.cybersource.com/tss/v2/searches "save": "false", "name": "Search By Code", "timezone": "America/Chicago", "query": "clientReferenceInformation.code:123456", "offset": 0, "limit": 100, "sort": "id:asc, submitTimeUtc:asc" } |
|
Function: Order Detail Report (Transaction Request Report in New Business Center) Servlet Request: https://<server_name>/ebc/Query?merchantID=merchant1&requestID=5187901209120179112634&type=orderPaymentData REST Request: https://api.cybersource.com/reporting/v3/report-downloads { "organizationID": "myorg", "reportDate": "2018-05-23", "reportName": "TransactionRequestReport" } |
|
Function: Notification of Change Servlet Request: https://<server_name>/ebc/Query?merchantID=pa_rbsworldpay&startDate=2018-02-15&endDate=2018-02-16&type=NOC&exportType=xml REST Request: https://api.cybersource.com/reporting/v3/notification-of-changes { "startTime": "yyyy-MM-dd'T'HH:mm:ssXXX", "endTime": "yyyy-MM-dd'T'HH:mm:ssXXX" } |
|
Function: Batch Submission Detail Report Servlet Request: https://<server_name>/ebc/batchupload/ResponseFileWrite.do?merchantID=merchant1&batchID=12345&format=csv&password=password&username=username REST Request: https://api.cybersource.com/pts/v1/transaction-batches { "startTime": "yyyy-MM-dd'T'HH:mm:ssXXX", "endTime": "yyyy-MM-dd'T'HH:mm:ssXXX" } |
|
Function: Conversion Detail Report Servlet Request: https://<server_name>/ebc/ConversionDetailReportRequest.do?merchantID=testmerchant&startDate=2018-03-23&startTime=00:00:00&endDate=2018-03-23&endTime=23:59:59&username=username&password=password REST Request: https://api.cybersource.com/reporting/v3/conversion-details { "startTime": "yyyy-MM-dd'T'HH:mm:ssXXX", "endTime": "yyyy-MM-dd'T'HH:mm:ssXXX" "organizationId": "organizationID" } |
|
Function: Purchase and Refund Details (Acquiring) Servlet Request: https://<server_name>/ebc/DownloadAcquiringReports?hierarchyId=1234&organizationId=orgID&reportId=75&startDay=01&startMonth=12&startYear=2017&endDay=31&endMonth=12&endYear=2017&format=xml REST Request: https://api.cybersource.com/reporting/v3/purchase-refund-details { "startTime": "yyyy-MM-dd'T'HH:mm:ssXXX", "endTime": "yyyy-MM-dd'T'HH:mm:ssXXX" "organizationId": "organizationID" "paymentSubtype": "ALL" "viewBy": "requestDateâ "groupName": "group1" "offset": "5" "limit": "2000" } |
|
Function: Check the Payment Status (for merchants using certain processors) Servlet Request: https://<server_name>/ebc/Query?merchantID=testmerchant&requestID=1234&type=transaction&subtype=transactionStatus&transRefNo=56789&requestToken=abcd REST Request: https://api.cybersource.com/tss/v2/transactions/{id} |
|
Function: Get a List of Users in an Organization Servlet Request: https://<server_name>/ebc/UserListing?merchantID=qaebc2&format=xml REST Request: https://api.cybersource.com/ums/v1/users?organizationId=mymerchant |