Menu

Creating a Request With a Client Application

The client uses a GET, POST, and PUT methods to send requests to the server. To send the request, the header must contain an authorization token and the format for the report you want to download.

Request Format

To create a request, your client application must send an HTTP message to the report server. The URL and method that you specify in your message indicates which function you are calling and the parameters of the call. Partners can specify the organizationId, which enables them to create requests that return data for a specific merchant. For example, if you wanted to download a report, you would format the URL as follows:
https://<
url_prefix>/reporting/v3/report-downloads?organizationId={organizationId}&download=true&reportDate={date}&reportName={reportName}
If the
organizationId
is
SampleMerchant
, you would use the following URL to download the report from February 20, 2018 titled SampleDailyReport from the production system:
https://<
url_prefix>/reporting/v3/report-downloads?organizationId=SampleMerchant&reportDate=20180220&reportName=SampleDailyReport
IMPORTANT
You only need to pass the organizationId in the request if you are a partner creating a request to retrieve data for a specific merchant. Otherwise, organizationId is passed in your authentication method and not required in the request.

Client Application Requirements

To connect to the report server, your client application must support HTTPS connections. An HTTPS connection is similar to an HTTP connection, but it is encrypted by using Transport Layer Security (TLS). Your client application must support HTTP/1.1 and TLS 1.2 connections.
HTTPS libraries are available for many programming languages, including Java, C/C++, Perl, and Visual Basic. You can implement a client in any language that allows you to use HTTPS to communicate with the report server.
IMPORTANT
Although you may be able to use a third-party client application to download the reports, we do not recommend or support third-party client applications or client libraries that may interfere with our applications.

Request Header

The default format for responses is JSON, but some reports can also return CSV or XML. You can set the response to return CSV or XML in the request header by setting the
Accept
value to either
application/xml
or
text/csv
. The report format can be set for the following reports:
  • Conversion Detail
  • Purchase and Refund Detail
Back to top