Request Field Description

M: mandatory, O: optional

POST /online/gateway

retrieve the available payment information (type, desc, longDesc, logo) from PMS

REQUEST

apiKey	M	String
sign	M	String	​use a key the encrypt the timestamp
timestamp	M	Long	​current timestamp (milliseconds)	server will expired the request with very old timestamp
lang	O	String	language setting, default: zh_hk	e.g.: zh_hk, zh_cn, en

RESPONSE

errorCode	M	String
errorMessage	O	String
gateways	M	Object	see gateways below
extendParam	O	String

gateways

type	M	String	payment type	e.g.:FPSPAY
desc	M	String	description	e.g.:Faster Payment System Pay
langDesc	M	String	long descriptions (support multi languages), depend on ‘lang’ in the request	e.g.: 轉數快, 信用 卡支付

Example of Online Gateway

Api

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

Request

{
    "apiKey": "pxBf7pn6IswN7b4N",
    "lang": "zh_hk",
    "sign": "oqfrzy/ABJH4vn+LA0E4wz1UA0c=",
    "timestamp": 1623205724171
}

Response

{
    "extendParam": "",
    "gateways": [{
                  "type": "WXPAY",
                  "desc": "Wechat Pay",
                  "langDesc": "微信支付",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }, {
                  "type": "ALIPAY",
                  "desc": "Alipay",
                  "langDesc": "支付寶",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }, {
                  "type": "ALIPAYOS",
                  "desc": "Alipay Oversea",
                  "langDesc": "支付寶(香港)",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }, {
                  "type": "FPSPAY",
                  "desc": "Faster Payment System Pay",
                  "langDesc": "轉數快",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }, {
                  "type": "VMPAY",
                  "desc": "Visa/Master Online",
                  "langDesc": "信用卡支付",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }, {
                                    12/22
                  "type": "UNIONPAY",
                  "desc": "Union Pay",
                  "langDesc": "銀聯(信用卡)支付",
                  "base64Logo": "data:image/svg+xml;base64,..."
            }
      ],
      "errorCode": "0",
      "errorMessage": "no error"
}