Start Session Terminal

Query Params
string
required

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

string
required
length ≤ 16

Password for the Terminal ID (provided by SportsPay).

string
enum
required

Type of transaction (W for Web-Redirect).

Allowed:
string
enum
required

Defines the action to perform. For this request, it will be StartSession.

Allowed:
string

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

string
required

Amount to be processed in dollars and cents (numeric with decimal).

string
required

Unique value assigned to the request to prevent duplicate sessions.

string
required

Identifier of the terminal device that should receive the request.

string
required

Customer's email address (max 60 characters; accepts standard email characters: alphanumeric and @ . ! # $ % + - _ { | } ~).

string

Callback URL for approved transactions.

string

Callback URL for failed or declined transactions.

string

Refund flag. Valid usage:

  • REFUND=Y
  • REFUND
string

Disable terminal printing. Valid usage:

  • NOTERMPRINT=Y
  • NOTERMPRINT
Response

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