For the complete documentation index, see llms.txt. This page is also available as Markdown.

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):

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):

☑️ 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):

Last updated

Was this helpful?