Transaction Queries

Searches historical transactions by reference, invoice, amount, card last-4, authorization number, or date range. Also retrieves batch settlement reports. Returns up to 10 records per call; use SKIP to paginate.

Searches historical transactions by reference, invoice, amount, card last-4, authorization number, or date range. Also retrieves batch settlement reports. Returns up to 10 records per call; use SKIP to paginate.

Body Params

Transaction reports using different transaction fields.

string
required
^[a-zA-Z0-9]{8}$

Terminal ID of the merchant (8 alphanumeric characters). Must always be the first field.

string
required
length ≤ 16
^[a-zA-Z0-9]+$

Password for the Terminal ID (provided by SportsPay).

string
enum
required

Type of request. Q for all queries.

Allowed:
string
enum
required

Sub-type. T for transaction queries.

Allowed:
string
^[a-zA-Z0-9]{5,20}$

Invoice number associated with the transaction (5-20 alphanumeric characters). Acts as a transaction tag — does not need to be unique.

string
^[a-zA-Z0-9\-/]{1,32}$

Reference number of the transaction to look up (accepts alphanumeric, -, and /; max 32 characters).

string
^\d{4}$

Last 4 digits of the card number.

string
^\d+\.\d{2}$

Amount of the transaction in dollars and cents (Numeric with decimal - i.e. 1.00).

string

Authorization number.

string
enum

Transaction approval status: Y for approved, N for not approved.

Allowed:
integer

Number of transactions to skip.

Response

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