支付开发接口文档支付开发接口文档
  • English
  • 简体中文
  • English
  • 简体中文
  • 介绍
  • 通用
    • 业务流程
    • 接口规则
    • 返回编码
  • 接口
    • 代收下单
    • 代付下单
    • 代收回调
    • 代付回调
    • 订单查询
    • 余额查询
  • 附录
    • 银行列表

订单查询

接口网关

URL address:

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

提示

此接口为测试接口,请向业务人员索要

请求参数

字段名变量名类型必填示例值说明
商户UIDmchidstringTRUE100000商户UID
商户订单号out_trade_nostringTRUE1.00966E+18商户订单号
支付产品channelstringTRUEgopay_payout(1) 支付方式: inpay_bankupi / vnpay_napas_vietqr
(2) 代付方式: inpay_payout / vnpay_payout

样例:

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

返回结果

字段名变量名类型必填示例值说明
错误码result_codestringTRUEOK结果码. OK:成功,其他:失败
返回消息result_msgstringTRUESUCCESS提示信息. SUCCESS:成功
数据对象chargeobjectTRUE返回支付对象(请看下方具体数据)

成功样例:

{
	"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_msg": "Invalid Request.[ Request header [authentication] Failure.]",
    "error_code": 400000
}

提示

[success] 这里是成功返回信息 在返回JSON数据中 result_code=OK 和 result_msg= SUCCESS 时才有 charge

  • [status] 为订单业务状态

    • 0-关闭订单
    • 1-等待支付
    • 2-支付成功
    • 3-支付失败
    • 4-正在支付
    • 5-结算成功
    • 6-退款成功
    • 7-投诉纠纷
  • [out_status] 为下游订单状态

    • 0-玩家取消支付
    • 10-商户取消支付
    • 1-等待确认
    • 21-玩家确认成功
    • 22-商户确认成功
    • 23-平台确认成功
    • 24-卡商确认成功
    • 31-玩家确认失败
    • 32-商户确认失败
    • 33-平台确认失败
    • 34-卡商确认失败
    • 4-正在支付
    • 5-结算成功
    • 6-退款成功
    • 7-投诉纠纷
  • [amount] 代收上分金额:商户和会员的上分请以该金额为准;代付下分金额:商户和会员的下分请以该金额为准

  • [order_amount] 代收下单金额:商户代收下单的原始金额;代付下单金额:商户代付下单的原始金额

  • [pay_amount] 代收收银金额:我方收银台展示给会员的应付金额;代付应付金额:我方银行和钱包应付给会员的金额

  • [amount_paid] 代收实收金额:我方银行和钱包实际收款金额;代付实付金额:我方银行和钱包实际付款金额

[error] 这里是错误返回信息 在返回错误数据中仅有 error_code 和 error_msg

Prev
代付回调
Next
余额查询