About the "webhookUrl"

- The webhookUrl is provided by merchants, and PMS will keep sending a HTTP

POST request to the “webhookUrl”, to notify merchants.

- Notifications will be sent each 5 minutes. Stop after 5 notify sent or a valid

response from merchants.

- for example:

webhookUrl: https://www.xxx.com/service/order-paid/648

request:

{
	"storeCode": "TT001",
	"tillId": "01",
	"type": "VMPAY",
	"rrn": "002105250533384472389602",
	"amount": 10,
	"gwRefCode": "2eca6f1c-d2fc-4dc7-8b60-464a29f632c0",
	"txDatetime": "2021-05-25T17:33:38+0800",
	"salesman": "9999",
	"orgRrn": ""
}
response (if there is):
{
	"errorCode": "0"
}

POST /online/query

Query the rrn of payment status.

REQUEST

apiKey	M	String
type	M	String		e.g.: WXPAY, ALIPAYOS, ALIPAY, FPSPAY
rrn	M	String	the unique transaction ID	the unique reference number
timestamp	M	Integer	current timestamp	server will expired the request with very old timestamp
sign	M	String	​use a key the encrypt the timestamp
storeCode	M	String		ST01
tillID	O	String		01
lang	O	String	language code	e.g.: zh-CN, zh-HK

RESPONSE

errorCode	M	String		details see ErrorCode
errorMessage	O	String
type	M	String
rrn	M	String
storeCode	O	String
tillId	O	String
txDateTime	M	String
amt	M	Integer
ccy	M	String
gwRefStatus	M	String		details see GwRefStatus
gwRefCode	M/O	String		gateway reference code
gwErrorCode	O	String		gateway error code
gwErrorMessage	O	String		gateway error message

Example of Online Query

Api:

https://pms-prod-fps.ttretail.com/tt-pms-ws/online/query

Request

{
    "apiKey": "pxBf7pn6IswN7b4N",
    "timestamp": "1623724168633",
    "sign": "6qLdwsBVo1brE2A2n7IVMtFsMAM=",
    "type": "WXPAY",
    "rrn": "25115260676212289",
    "storeCode": "ST01",
    "tillId": "01"
}

Response

{
    "type": "WXPAY",
    "rrn": "25115260676212289",
    "storeCode": "ST01",
    "tillId": "01",
    "txDateTime": "2021-06-01T15:01:13+0800",
    "amt": 1,
    "additionalAmt": 0,
    "ccy": "HKD",
    "lang": null,
    "gwRefStatus": "01",
    "gwRefCode": "4200001019202106017620699482",
    "gwErrorCode": "0",
    "gwErrorMessage": "SUCCESS",
    "extendParam": "",
    "orgRrn": "",
    "orgGwRefCode": "",
    "errorCode": "0",
    "errorMessage": "SUCCESS"
}