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

代付下单

接口网关

URL address:

https://pay.xxx.io/pay/unifiedorder

提示

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

请求参数

字段名变量名类型必填示例值说明
商户UIDmchidstringTRUE100000商户UID
商户用户IDuseridstringTRUEU123456789商户用户ID
商户订单号out_trade_nostringTRUE1.00966E+18商户订单号
商品描述subjectstringTRUE会员充值商品简单描述
商品信息bodystringTRUE会员充值支付商品信息
支付金额amountfloatTRUE1000支付总金额,两位精度
支付产品channelstringTRUEinpay_payout(1) 支付方式: inpay_bankupi/vnpay_napas_vietqr
(2) 代付方式: inpay_payout /vnpay_payout
附加数据extparamstringTRUE如果是代付请求(channel为inpay_payout/vnpay_payout),则extparam需要添加userid bankname bankcode bankaccount accountname参数,参数格式为json
货币代码currencystringTRUEINR支付币种: CNY, INR, VND
终端IPclient_ipstringTRUE127.0.0.1发起支付IP
回调地址notify_urlstringFALSE异步回调地址: 为空或者不传则不回调
跳转地址return_urlstringFALSE同步跳转地址: 为空或者不传则不跳转

样例:

{
	"extparam": {
		"accountname": "Nguyễn Thành Phát",
		"bankaccount": "0824287105",
		"bankcode": "MB"
	},
	"amount": 10000,
	"mchid": 100000,
	"out_trade_no": "23092024183233784",
	"subject": "pay_test",
	"channel": "vnpay_payout",
	"return_url": "http://localhost:8001/demo.html",
	"currency": "VND",
	"client_ip": "127.0.0.1",
	"body": "pay_test",
	"notify_url": "http://localhost:8001/cashier/demonotify",
	"userid": "U123456789"
}

提示

extparam参数说明

  • 当channel是代付inpay_payout/vnpay_payout时,extparam需要添加bankcode/bankaccount/accountname参数:
{
	"accountname": "Nguyễn Thành Phát",
	"bankaccount": "0824287105",
	"bankcode": "MB"
}

返回结果

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

成功样例:

{
	"result_code": "OK",
	"result_msg": "SUCCESS",
	"charge": {
		"channel": "vnpay_payout",
		"out_trade_no": "23092024183233784",
		"client_ip": "127.0.0.1",
		"amount": "10000",
		"currency": "VND",
		"subject": "pay_test",
		"body": "pay_test",
		"extparam": {
			"accountname": "Nguyễn Thành Phát",
			"bankaccount": "0824287105",
			"bankcode": "MB"
		},
		"credential": {
			"out_trade_no": "9451fa8fac8569dab6443cb54270728a",
			"merchant_wallet": {
				"uid": 100000,
				"total_limit_credits": "-1000000000.00",
				"total_security_deposit_credits": "0.00",
				"total_unsettled_credits": "121356.33",
				"total_hold_credits": "0.00",
				"total_commission_credits": "229.47",
				"total_available_credits": "-42728.13"
			}
		}
	}
}

失败样例:

{
    "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-投诉纠纷

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

Prev
代收下单
Next
代收回调