Transaction Reports

Transaction Reports

Transaction reports allow to retrieve detailed transactional data from the platform. The information retrieved is related to the transactions being processed by the system and can be filtered using different filter paramters and options.

All reporting should be done through the new endpoint v3/query. The previous version is still available, but in case you are looking for more filtering options and pagination consider to move to the latest version.
Click on the links to navigate to the right option for your use case.

Quick links

Get transaction by id

The payment identifier id is the identifier generated by the system. It is unique per transaction and can be used to get information on a specific transaction.

If this identifier is available it can be used to query the platform by adding it directly in URL. For example:

Advanced options

Additional parameters are available to make requests with advanced filtering and returning all transactions linked to the original one. The following parameters can be used:

  • includeLinkedTransactions - If set to true, the query returns all transactions linked to the original (default value is false)
  • paymentTypes - this parameter is used to filter the response and return only the specified payment types, for example paymentTypes=PA,CP,RV
  • paymentMethods - this parameter is used to filter the response and return only the specified payment methods, for example paymentMethods=CC,DC

Please see the API Reference for a full list of possible values.

Example:

Get transaction using short Id

The payment identifier shortId is the identifier generated by the system. It is unique per transaction and can be used to get information for a specific transaction. The merchantTransactionId or date.from and date.to parameters are mandatory to be added along with shortId to the request.

To query the system and get the transaction related to shortId, add it as query parameter as follows:

Get transaction using your order reference

An order can involve multiple transactions in the platform (e.g. PA, CP, 3D, ...). The parameter merchantTransactionId, as a best practice, should be used in all transactions as order identifier. For this reason it can be also used to query and get all the transactions for a specific order. From the response of this query more than one entry is expected.

To query the system and get all the transactions related to a single merchantTransactionId, add it as query parameter as follows:

Get transactions for a specified time frame

To retrieve a list of transactions for a specified time frame it is possible to add the date.from and date.to parameters to the request. To limit the number of entries returned for a request use the parameter limit (min: 100 ma: 500).

If the parameter limit is omitted in the request, the default value of 100 will be used and, depending on the number of results, pagination will be used.


Additionally, it is still possible to filter the result using paymentTypes and paymentMethods filtering options.
Request must contain either merchantTransactionId or date.to/date.from and parameters. Please see the API Reference for further details.

How to use pagination

Since the number of records returned by quering for a specific timeframe can be considerable, this endpoint implements pagination. To use pagination, specify the page number in the parameter pageNo.

In all requests with pagination the option limit is ignored and the page size is by default set to 100.

Previous version

To see the documentation related to the previous v1/query version click the button.