Start Session

Initiates a payment or refund on a terminal.

IMPORTANT:

  • CODE=0000 means request sent to terminal
  • It does NOT mean the transaction was approved
  • You MUST wait for the webhook callback for final result
  • Do NOT assume success based on StartSession response
Query Params
string
required

Terminal ID

string
required

Terminal password

string
enum
required

Must be W

Allowed:
string
enum
required

API action

Allowed:
string

Invoice number

string
required

Transaction amount

string
required

Unique request ID

string
required

Terminal device ID

string
required

Customer email address

string

Callback URL for approved transactions

string

Callback URL for failed/declined transactions

string

Refund flag. Valid usage:

  • REFUND=Y
  • REFUND
string

Disable terminal printing. Valid usage:

  • NOTERMPRINT=Y
  • NOTERMPRINT
Response

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