List all Transactions

This endpoint returns a list of Transactions. The list can be filtered by a number of Transaction properties.

By default the paging.mode is set to nocount, this means that the list total count will not be included in the response. Setting the paging.mode parameter to full will enable the total count. However, we urge Partners to exercise caution when including the total count on the Transaction list endpoint. The total number of Transactions can grow significantly and counting them can become taxing on the system. Paging.mode full is likely to result in high latency, therefore we suggest that you adopt a pagination strategy that does not require the total count.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter the list by Partner. The parameter value can be either a Partner ID or Name.

string

Filter the list by Client. The parameter value can be either a Client ID or Name.

string

Filter the list by Location. The parameter value can be either a Location ID or Name.

boolean
enum

Filter the list by success indicator.

Allowed:
string

Filter the list by transaction date. Only show transactions that were processed after this date.

string

Filter the list by transaction date. Only show transactions that were processed before this date.

string

Filter the list by Message ID.

string

Filter the list by the ClientRef ID.

string

Filter the list by Device serial number.

string

Filter the list by Reference ID.

int32
Defaults to 10

The number of entries to include in the list.

int32
Defaults to 0

The number of results to skip before listing entries.

string
enum
Defaults to nocount

Toggles the total count in the response.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json