Versions Compared

Key

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

Installation

...

6) Send the respective HTTP request.

API Documentation

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

POST /my-debit-sale

/revenue-terminals/my-debit-sale

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 my debit sale transaction (in decimal format)

payAddAmount

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

terminalId

An identifier for the terminal

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

POST /void-sale

/revenue-terminals/void-card-sale

Voids 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

traceNo

The trace number of the transaction to be voided

payAmount

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

terminalId

An identifier for the terminal

POST /settlement

/revenue-terminals/settlement

Processes a settlement request.

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 /qr-sale

/revenue-terminals/qr-sale

Processes a QR 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 QR sale transaction (in decimal format)

terminalId

An identifier for the terminal

Payment Provider Constants

Pay Issuer

Pay Issuer ID

VISA

1

VISA_06_INSTALLMENT

2

VISA_12_INSTALLMENT

3

VISA_18_INSTALLMENT

4

VISA_24_INSTALLMENT

5

VISA_36_INSTALLMENT

6

VISA_48_INSTALLMENT

7

MASTERCARD

8

MASTERCARD_06_INSTALLMENT

9

MASTERCARD_12_INSTALLMENT

10

MASTERCARD_18_INSTALLMENT

11

MASTERCARD_24_INSTALLMENT

12

MASTERCARD_36_INSTALLMENT

13

MASTERCARD_48_INSTALLMENT

14

MY_DEBIT

15

AMEX

16

JCB

17

DINERS

18

UNIONPAY

19

NETS

20

ALIPAY

80

WECHAT

81

UPIQR

82

TNG

83

BOOST

84

VCASH

85

GRAB

86

SHOPEE

88

DUIT_NOW

90

WANNA_PAY

91

SARAWAK_PAY

92

ALIPAY_PLUS

93

TNGCARD

94

GRAB_BUY_NOW_PAY_LATER

96