Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /ping

/revenue-terminals/ping

Pings the terminal to establish a WebSocket connection.

Parameters should be passed as query parameters.

terminalIp

The IP address of the terminal

terminalPort

The port number of the terminal for the connection

terminalId

An identifier for the terminal

POST /card-sale

/revenue-terminals/card-sale

Processes a card sale transaction.

Parameters should be passed as query parameters.

terminalIp

The IP address of the terminal

terminalPort

The port number of the terminal for the connection

payAmount

The monetary amount of the card sale transaction (in decimal format)

terminalId

An identifier for the terminal

...

Processes a debit sale transaction.

Parameters should be passed as query parameters.

terminalIp

The IP address of the terminal

terminalPort

The port number of the terminal for the connection

payAmount

The monetary amount of the debit sale transaction (in decimal format)

payAddAmount

The monetary amount of the debit sale transaction (in decimal format) to be added

terminalId

An identifier for the terminal

cancelSale

Endpoint

Method

Description

Request Example

Respond Example

...

POST /cancel-sale

/revenue-terminals/cancel-sale

Cancels the current sale transaction.

Parameters should be passed as query parameters.

terminalIp

The IP address of the terminal

terminalPort

The port number of the terminal for the connection

terminalId

An identifier for the terminal

voidSale

Endpoint

Method

Description

...