Transaction download

[email protected] --ask-password

The CSV file can be downloaded using a HTTPS POST query string with Basic Access Authentication. Basic Access Authentication is a method for a web browser client program to provide a username and password when processing a request.

Supported user roles

You can use your Webservices username and password to download transaction records and reports. If you do not already have a Webservices username, you can create a new user using MyST.

We also support two additional user roles for CSV downloads. These are “Transaction download” and “Report download”, for downloading transaction records and reports respectively. To set up users with these roles, please contact our Support Team.

Authorisation header

A username and password, separated by a colon, then base64 encoded must be included in the authorisation header when performing the request. Most URL libraries will construct the basic authentication header automatically, but if you need to perform this manually, please follow this example:

Username: [email protected]
Password: pa55word
Separated by a colon: [email protected]:pa55word
Base64 encode: Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=

Therefore, the authorisation header should be:

Authorization: Basic Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=

sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100

By default, all transactions within the date range for the specified site reference(s) will be returned in the download. Filters can be applied to the download so only certain records are returned. In the example above, the following filters have been applied:

• Site reference: test_site12345
• Transaction authorisation date: 1^st January 2017 – 31^st January 2017
• Settle status: 100

Multiple values for the same filters can be included in the call separated by an “&”.

For example, for downloading e-commerce and MOTO transactions, the accounttypedescriptions filter can be included twice with two different values:

sitereferences=site1&sitereferences=accounttypedescriptions=ECOM&accounttypedescriptions=MOTOsite2

Required filters

The following fields must be included in the POST data:

Data can be downloaded for multiple site references by including additional site references fields in the call separated by an “&”.

For example, if transactions are needed for site1 and site2, the call would include the following:

sitereferences=site1&sitereferences=site2

Please note that even if downloading transactions for one site reference, the field must always be called sitereferences.

Optional filters

Useful filters

The following is a list of the most frequently-used filters by our merchants:
(Contact our Support Team to enquire about availability of additional filters)

Note that to search by settlestatus, the field must be called settlestatuss.

Filter by time

Use the following filters to download data on transactions within a specified range of time:

For example, for downloading transactions between 13:30:00 and 14:29:59:

starttimehour=13&starttimeminute=30&endtimehour=14&endtimeminute=29

Date type

By default, dates and times specified are filtered based on when the transaction was initially processed. However, you can explicitly specify the type of date/time that is filtered by including the following additional filter:

If your system is processing a high volume of transactions, we recommend downloading CSV files of transactions on an hourly basis (instead of daily), for optimum performance and to reduce the size of the files downloaded. Your system can submit a request every hour, specifying the time filters as described above, to ensure only transactions processed in the last hour are included.

As a minimum, all transaction download CSVs will contain the transaction reference for each record returned.

Example output:

transactionreference
13-2-81000
13-28-1
13-28-10
13-28-11

You can specify additional fields to be returned in the transaction download, as shown in the example below

optionalfields=errorcode&optionalfields=currencyiso3a&optionalfields=authcode&optionalfields=orderreference&optionalfields=paymenttypedescription&optionalfields=settlestatus&optionalfields=settlemainamount&optionalfields=settleduedate&optionalfields=customercountryiso2a

The example above includes the following optional fields:

• Error code
• Currency
• Auth code
• Order reference
• Payment type
• Settle status
• Settle main amount
• Settle due date
• Customer country

The output would contain these optional fields. The field names specified in the request are shown on the first line of the CSV output, in the same order:

transactionreference,errorcode,currencyiso3a,authcode,orderreference,paymenttypedescription,settlestatus,settlemainamount,settleduedate,customercountryiso2a
23-9-1,0,GBP,TEST,20161,VISA,100,10.99,2017-01-03,GB
23-9-2,0,GBP,TEST,20162,MASTERCARD,100,11.98,2017-01-10,GB
23-9-3,0,GBP,TEST,20163,MASTERCARD,100,10.99,2017-01-11,GB
23-9-4,0,GBP,TEST,20164,MASTERCARD,100,10.99,2017-01-16,GB

If a requested optional field has no value, an empty string will be returned in the CSV.

Full list of optional fields

The following sections list fields that can be included in the output, if specified in the request:

Transaction details

Payment details

Settlement details

Security response

The response of the AVS and Security Code Checks checks performed during authorisation. This can be one of the following values:

• 0 = DATA NOT GIVEN
• 1 = DATA NOT CHECKED
• 2 = DATA MATCH
• 4 = DATA NOT MATCHED

Billing details

Delivery details

Merchant details

Replace the domain in the example provided with one of the following URLs:

• https://myst.securetrading.net/ (European Gateway)
• https://myst.securetrading.us/ (US Gateway)

Example (using the European Gateway):

https://myst.securetrading.net/auto/transactions/transactionsearch