Payment Web API
Search
K

Payment Status Query API (Common)

Retrieve the payment transaction process status by order id, for all the payment methods

API Request Parameters(HTTP-Request-Body )

Params Name
Description
Required
Notes
action
Action name (Constant Value)
Y
"STATUS_QUERY"
version
Version number
Y
"1.0"
merchant_id
Merchant ID
Y
Provided by OTT Pay
data
Encrypted Transaction Data
Y
See "Data" table below
md5
Message Digest
Y
☑️
Request Example(JSON Data):
{
"action":"STATUS_QUERY",
"version":"1.0",
"merchant_id":"QC00005496",
"data": "zTadPG0YM4gD1WOFqxg7wn3vmU20NjCnCUOOnE9mTTkxYraQDflljA8W3azYG9MuOvOyl3cZhafH+io6PiWdZCwRmi3HGa19BvT215IIxRy2HvYe0Sqs2lxshm9E4y5F1gJ7HHMTqpY0wIA4DsuWA97UC55adB2G86VbanI7B5a3kErApr5mbAoE7wcNbDJfGh4CBbSoRxQyiGZ48SvYuIW/sclT4yu6okjo6CY3xL4=",
"md5":"6AFB2E94A70D9A208F101723700EB287"
}

☑️
Data(JSON Data, to be encrypted):

Params Name
Description
Required
Notes
order_id
Order ID
Y
OrderID could be generated by client's code, or generated by OTTPay as default
☑️
Data Example(JSON Data,to be encrypted):
{
"order_id":"2020041468976O124O000857",
}

API Response Parameters(HTTP-Response-Body)

Params Name
Description
Required
Notes
rsp_code
Response code
Y
refer to Appendix B
rsp_msg
Response message
Y
data
Encrypted Data
Y
See "Data" table below
md5
Message Digest
Y
☑️
Response Example(JSON Data):
{
"rsp_code":"SUCCESS",
"rsp_msg":"success",
"data":"41kiLvjVBO8AW4wTOthI92OQu+8fwac5cIDx0DoZpitLvSJU8WKQbk5Bii5ZYrgLz4hepQ865QZFWqj2PRZ1FjxxipxEy2KoOKchWK09e42Se3CMAxt/+8UGrnAHDJLbU/BBlZLJoLpruSNKBeVfwhI7TtGdP4ciwzKPmv5aS2DWoU4Jl26IAPa8PeGhPNLuT99HwBGXa7aUz5adYk3uAR5Ww9HkBlPrqzJlUQ4zdMgjxaM2bROldcKTK8NxPM7X",
"md5":"32310A0DD3D021A7D0CDF6A5909A1A61"
}

☑️
Transaction Data(JSON format, After decrypted)

Params Name
Description
Required
Notes
order_status
Order status
Y
trade_time
Transaction time
N
order_id
Order ID
Y
payNo
Transaction reference code, same as bizpay_order_id
Y
e.g.WX31882313410964473
buyer_login_id
Buyer ID
N
total_amount
Order total amount
N
Number, 100 for 100 dollar
receive_amount
Merchant receive amount
N
Number, 100 for 100 dollar
pay_amount
User pay amount
N
Number, 100 for 100 dollar
tip
tip amount
N
Number, 100 for 100 dollar
refund_fee
Refund fee
N
Only exist for a refunded order
☑️
Data Example(JSON Data, after decrypted):
{
"order_id":"2020041468976O124O000857",
"total_amount":1,
"refund_fee": 0,
"order_status":"init",
"trade_time":"Apr 14, 2020 12:08:58 AM",
"tip": 0
}