Query Order

Interface Gateway

URL address:

https://pay.xxx.io/pay/orderquery

Tips

This interface is a test interface, please ask the sales person for it

Request Parameter

Parameter Name	Variable Name	Type	Required	Example	Comment
Merchant UID	mchid	string	TRUE	100000	Merchant UID
Merchant Trade No	out_trade_no	string	TRUE	1.00966E+18	Merchant Trade No
Pay Code	channel	string	TRUE	inpay_payout	(1) Payment: inpay_bankupi/vnpay_napas_vietqr (2) Payout: inpay_payout/vnpay_payout

Example:

{
	"mchid": 100000,
	"out_trade_no": "23092024183233784",
	"channel": "vnpay_payout"
}

Response Result

Result Name	Variable Name	Type	Required	Example	Comment
Result Code	result_code	string	TRUE	OK	Result Code. OK: Success, Other: Failure
Return Message	result_msg	string	TRUE	SUCCESS	Prompt Information. SUCCESS: success
Payload	charge	object	TRUE		Return the payment payload object (please see the specific data below)

Success Example:

{
	"result_code": "OK",
	"result_msg": "SUCCESS",
	"charge": {
		"uid": 100000,
		"userid": "U123456789",
		"out_trade_no": "23092024183233784",
		"trade_no": "9451fa8fac8569dab6443cb54270728a",
		"in_trade_no": "",
		"subject": "pay_test",
		"body": "pay_test",
		"channel": "vnpay_payout",
		"paytype": 0,
		"extra": "{\"accountname\":\"Nguyễn Thành Phát\",\"bankaccount\":\"0824287105\",\"bankcode\":\"MB\"}",
		"currency": "VND",
		"amount": "10000.000",
		"order_amount": "10000.000",
		"pay_amount": "10000.000",
		"amount_paid": "10000.000",
		"keyword": null,
		"urate": "0.000",
		"ufixed_fee": "0.000",
		"user_in": "10000.000",
		"client_ip": "127.0.0.1",
		"return_url": "http://localhost:8001/demo.html",
		"notify_url": "http://localhost:8001/cashier/demonotify",
		"image_list": null,
		"image_text": null,
		"remark": null,
		"create_time": 1727087554,
		"update_time": 1727088044,
		"out_status": 23,
		"status": 2,
		"is_status": 0
	}
}

Error Example:

{
    "error_msg": "Invalid Request.[ Request header [authentication] Failure.]",
    "error_code": 400000
}

Tips

[success] This is the successful return information, only when result_code=OK and result_msg= SUCCESS in the returned JSON data can charge

• [status] is order business status:

  • 0-closed
  • 1-waiting
  • 2-success
  • 3-failure
  • 4-paying
  • 5-settled
  • 6-refunded
  • 7-dispute

• [out_status] is merchant trade order status

  • 0-player cancel payment
  • 10-merchant cancel payment
  • 1-waiting
  • 21-player confirm success
  • 22-merchant confirm success
  • 23-gateway confirm success
  • 24-bank confirm success
  • 31-player confirm failure
  • 32-merchant confirm failure
  • 33-gateway confirm failure
  • 34-bank confirm failure
  • 4-paying
  • 5-settled
  • 6-refunded
  • 7-dispute

• [amount] Payment credit amount: Merchants and members should credit this amount; Payout debit amount: Merchants and members should debit this amount

• [order_amount] Payment order amount: The original amount of the payment order placed by the merchant; Payout order amount: The original amount of the payout order placed by the merchant

• [pay_amount] Payment cashier amount: The payable amount shown to members in cashier page; Payout payable amount: The payable amount by our bank/wallet

• [amount_paid] Payment received amount: the actual amount received by our bank/wallet; Payout paid amount: the actual amount paid by our bank/wallet

[error] This is the error return information only have error_code and error_msg in the returned JSON data