Query Transaction API

API Request Parameters(HTTP-Request-Body )

Params Name

Description

Required

Notes

action

Action name

Y

String, “PREPAY_QUERY”

version

Version number

Y

String, “2.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":"PREPAY_QUERY",
    "version":"2.0",
    "merchant_id":"QC00005496",
    "data": "zTadPG0YM4gD1WOFqxg7wn3vmU20NjCnCUOOnE9mTTkxYraQDflljA8W3azYG9MuOvOyl3cZhafH+io6PiWdZCwRmi3HGa19BvT215IIxRy2HvYe0Sqs2lxshm9E4y5F1gJ7HHMTqpY0wIA4DsuWA97UC55adB2G86VbanI7B5a3kErApr5mbAoE7wcNbDJfGh4CBbSoRxQyiGZ48SvYuIW/sclT4yu6okjo6CY3xL4=",
    "md5":"6AFB2E94A70D9A208F101723700EB287"
}

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

Params Name

Description

Required

Notes

prepay_order_id

Prepay order

Y

order_id

Order id

N

merchant_id

Merchant id

Y

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

rspCode

Inquiry Response code

Y

rspMsg

Inquiry Response message

Y

merchant_id

Merchant ID

Y

merchant_name

Y

amount

Payment amount

Y

tip

Tip Amount

N

shop_id

Store ID

Y

operator_id

Operator

Y

status

status

“SUCCESS”: payment successfully, ”ORDERCLOSE”: payment fail, ”PROCESSING”: payment on processing

call_back_url

Call back URL

redirect_url

Redirect URL

biz_type

Y

“PREPAY”

prepay_order_id

Prepay Order ID

Y

order_id

Order ID

N

Order_id in OTT Pay system, if the prepay order is implemented with a payments method, it will not be null

sale_num

Sale number

Y

The sale number or invoice number from merchant

email

Buyer email

N

remarks

Remarks

N

currency_type

currency

Y

CAD/USD/CNY

duration

Payment duration

Y

create_time

create time

Y

Only exist for a refunded order

expire_time

expire time

Y

payments_methods

Payment list

Y

The list of available payment to the prey pay order

Last updated

Was this helpful?