Reporting APIs

Integration Notes

Connectivity Information

The connection URL for the sandbox server is: https://sandbox-portal.tidypay.com/reports/[report-name].[report-format]?[parameters], where

[report-name] is a name of a report;
[report-format] - format in which the report is generated, see integration notes for more information;
[parameters] - fields in the report request, indicating what data is going to be included in the report.

For example, to generate a merchant-statement-list report in the CSV format, connection URL should look similar to the following one:
https://sandbox-portal.tidypay.com/reports/merchant-statement-list.csv?userName=myUsername&password=myP%40ssword&fromDate=10180101&toDate=20180131&accountId=2001

Authorization is done via service users. To access the API, a service user is required to be granted with a corresponding privilege. A user can submit API requests using either associated credentials or temporary password generated via authentication operation. To learn more about service users and end-points used for API submission, review Security Management guide.

Request method is POST. The content-type must be set to application/x-www-form-urlencoded.
Request fields are passed within HTTPS request body (including cases with callbacks) and are required to be URL-encoded.
Response fields are passed within HTTPS response body.
Both request and response field values are passed using name1=key1&name2=key2 format.

Fields Name Convention

Reports may contain data from different sources: merchant, transaction, terminal, etc. To differentiate fields within a report, the following name convention is used: [object].[group].[field-name], where

[object] is an entity within the gateway associated with the field (for example, merchant, reseller, terminal);
[group] is a criterion combining two or more fields in a logic group (for example, references - fields referencing an entity within a submitter’s system, processor - fields that were received from a processor);
[field-name] is a name of the field.

For example, the transaction.billingAddress.zipCode field represents a zip code, which is associated with the transaction and is a part of a billing address of a payment card or bank account holder.

Report Formats

Reports can be generated in one or more of the following formats:

PDF - report is generated and subsequently downloaded as a PDF file;
CSV - report is generated and subsequently downloaded as a CSV file in the pipe-delimited format;
data - report is generated and returned in the API response as a plain text in the pipe-delimited format.

To indicate what format should be used for a report generation in the API request, the format should be preceded by the name of the report, separated by a period. For example, to generate the merchant-statement report, a request should be similar to the following one:
https://sandbox-portal.tidypay.com/gates/reports/report/merchant-statement.pdf?userName=myUsername&password=myP%40ssword&statementId=300

Note that each report can be generated only in one or two formats. To verify what formats are supported for a report, see the table below:

	PDF	CSV	Data
merchant-statement-list		x	x
reseller-statement-list		x	x
deposit-list		x	x
transaction-list		x	x
transaction-list~related		x	x
split-list		x	x
terminal-list		x
merchant-statement	x
reseller-statement	x
reseller-statement-breakdown	x
transaction-receipt	x

All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.