跳至主要內容

下单


创建预下单交易,通过返回的信息进行支付。

相关信息

{domain}/Servlet/JSAPIService.do

https://vmp.eftpay.com.cn/VMP/Servlet/JSAPIService.do

名称类型描述要求
serviceString接口名称,详见 支持的service
user_confirm_keyString(12)用户Key,由 eftPay 提供
transaction_amountString(8)金额。要求数字,小数位最大长度为2
out_trade_noString(28)商户订单号
payTypeString(6)支付类型,详见 支持的payType
buyerTypeString(7)设备类型
iosandroidothers
subjectString(256)交易信息
walletString(20)钱包类型,详见 支持的wallet
bodyString(128)在需要描述各种商品的情况下,建议积累描述商品的字符串
pay_sceneString支付场景,默认请传 WEB,其他详见 支持的pay_scene
fee_typeString(5)货币类型,HKDCNY
默认:HKD
tidString(20)商户终端号
notify_urlString(240)通知地址,投产环境只支持 80443 端口,其他端口需要申请
return_urlString(240)支付完成后的返回地址。不能携带参数,投产环境只支持 80443 端口,其他端口需要申请
active_timeString有效时间,单位秒。默认30分钟,即1800
langString语言,固定值:cnenhk,详见 支持lang的service
customerInfoObject客户信息,支付类型为ATOME时有效,详见 ATOME参数说明
shippingAddressObject送货地址,支付类型为ATOME时有效,详见 ATOME参数说明
billingAddressObject账单地址,支付类型为ATOME时有效,详见 ATOME参数说明
itemsObject[]有关订单项的详细信息,支付类型为ATOME时有效,详见 ATOME参数说明
schemeStringAPP 应用 scheme,APP使用 webview 嵌套方式进行支付时有用。支付类型为UnionPay时有效
packageNameStringAPP 应用包名,APP使用 webview 嵌套方式进行支付时有用。支付类型为UnionPay时有效
app_linkStringAPP 链接,支付后跳回APP。钱包类型为BOCVMPUPI时有效
timeString时间,格式:yyyyMMddHHmmss
signString(64)签名

查看支持的 service 以及其对应的 payType 和 wallet

以下是 service、payType 和 wallet 三者之间的对应关系

servicepayTypewallet描述
service.alipay.wap.PreOrderAlipayALIPAYCN
ALIPAYHK
支付宝 wap 接口
service.wechat.web.MobileH5WeChatWECHATCN
WECHATHK
非微信内手机浏览器 H5 接口
service.wechat.oauth2.AuthorizeWeChatWECHATCN
WECHATHK
微信内公众号 H5 接口
service.icbc.wap.PreOrderICBCICBCWAPICBC wap 接口
service.atome.v2.wap.PreOrderATOMEATOMEATOME 线上接口
service.unionpay.online.web.PreOrderUnionPayUNIONPAY银联线上收银接口
service.oct.online.PreOrderOCTOCT八达通线上支付接口
service.fdms.web.PreOrderFdmsFDMSFDMS 的 VISA ,Master 支付
service.mpgs.web.PreOrderMpgsMPGSMPGS 的 VISA ,Master 支付
service.ae.web.PreOrderAEAEAE 支付
service.jetco.wap.PreOrderJetcoJETCOHK银通 wap 接口
service.payme.web.PreOrderPAYMEPAYMEPayMe web 支付接口
service.bocvmp.upi.wap.PreOrderBOCVMPBOCVMPUPIBOCPay wap 接口
查看支持的 service 以及其对应的 pay_scene

默认请传 WEB。使用以下接口时,需要注意对应的支付场景

servicepay_scene
service.wechat.oauth2.AuthorizeWXWEB
service.alipay.wap.PreOrderWAP
service.jetco.wap.PreOrderWAP
service.unionpay.online.web.PreOrderONLINE_WEB
service.payme.web.PreOrderWEB/APP
service.bocvmp.upi.wap.PreOrderH5/APP

提示

  • 当 pay_scene= WEB ,PayMe web支付接口返回一个二维码支付页面链接,用于PC端。
  • 当 pay_scene= APP ,PayMe web支付接口返回一个PayMe APP调起链接,用于移动端。
  • 当 pay_scene= H5 ,BOCPay wap 接口返回一个 BOCPay APP 调起链接,支付完成后会打开默认浏览器,跳转至 return_url。
  • 当 pay_scene= APP ,BOCPay wap 接口返回一个 BOCPay APP 调起链接,支付完成后会跳转至 app_link,参数需要自行验签。
  • 调起 BOCPay APP 参考 BOCPay集成指南v1.1.1
查看支持 lang 的 service

cn 为中文简体,hk 为 中文繁体,en 为英文

servicelang
service.oct.online.PreOrdercnenhk
service.mpgs.web.PreOrdercnenhk
service.ae.web.PreOrdercnenhk
service.jetco.wap.PreOrdercnenhk

transaction_amount

PAYME UAT 场可以通过 transaction_amount 的两位小数位来控制交易的状态

小数位描述示例
81  将创建一个 [成功] 的交易transaction_amount=0.81
80  将创建一个 [超时] 的交易transaction_amount=0.80
77  将创建一个 [失败] 的交易transaction_amount=0.77
44  将创建一个 [服务器错误-没有支付二维码] 的交易transaction_amount=0.44
45  将创建一个 [服务器错误-无状态]的交易transaction_amount=0.45

customerInfo
名称类型描述要求
mobileNumberString客户的手机号码,格式为 E.164。例如中国电话的国际写法(手机和座机)+8610123456。+861xxxxxxxxxx
fullNameString客户的全名

例子

"customerInfo": {
	"mobileNumber": "+8613344445555",
	"fullName": "Atome Developer"
}
shippingAddress
名称类型描述要求
countryCodeString送货地址,使用 ISO-3611 格式的两位数字国家/地区代码。例如 "SG" "HK" "MY" "ID" "TH" "TW" "VN" "PH"
linesArray送货地址,地址线。例如 ["中国", "香港","九龙",...]
postCodeString送货地址,邮政编码

例子

"shippingAddress": {
	"countryCode": "HK",
	"lines": ["中国", "香港"],
	"postCode": "999077"
}
billingAddress
名称类型描述要求
countryCodeString送货地址,使用 ISO-3611 格式的两位数字国家/地区代码。例如 "SG" "HK" "MY" "ID" "TH" "TW" "VN" "PH"
linesArray送货地址,地址线。例如 ["中国", "香港","九龙",...]
postCodeString送货地址,邮政编码
例子
"shippingAddress": {
	"countryCode": "HK",
	"lines": ["中国", "香港"],
	"postCode": "999077"
}
items
名称类型描述要求
temIdString此产品 / SKU 的 ID
nameString项目名称
quantityInt项目数量
priceInt商品的售价,单位分

例子

"items": [{
	"itemId": "P100",
	"name": "iPhone 12 pro max",
	"price": 11020,
	"quantity": 1
}, {
	"itemId": "P101",
	"name": "iPhone SE case",
	"price": 1000,
	"quantity": 1
}]

名称类型描述要求
return_statusString(3)返回状态码,代表。注:此参数不可作为交易状态是否成功的判断
其他状态码见 附录3
return_charString(100)返回说明,可能会变化,不能作条件判断
return_status 大于 00 时返回
timeString时间,格式:yyyyMMddHHmmss
return_status >= 00 时返回
signString(64)签名
return_status >= 00 时返回

名称类型描述要求
pay_apptradeString交易发起信息
user_confirm_keyString用户Key,由 eftPay 提供
out_trade_noString(28)商户订单号
payTypeString(6)支付类型
buyerTypeString(7)设备类型
walletString(20)钱包类型
eft_trade_noString(28)依付得订单号
fee_typeString(5)货币
transaction_amountString(8)交易金额
tidString(20)终端号,当消费请求有送的时候返回

{
	"pay_scene": "WAP",
	"user_confirm_key": "12345678",
	"wallet": "ALIPAYHK",
	"subject": "中文测试 test",
	"transaction_amount": "0.02",
	"sign": "af8f9f9d60019ce649af1ddfefd2aae98fa71656278a6edf439948cab7dc69d9",
	"body": "中文测试 test",
	"tid": "",
	"payType": "Alipay",
	"out_trade_no": "20190824010716",
	"service": "service.alipay.wap.PreOrder",
	"buyerType": "andriod",
	"return_url": "https://vmp.eftpay.com.cn/VMP/notify/testing",
	"time": "20190824010716"
}

{
	"user_confirm_key": "12345678",
	"wallet": "ALIPAYHK",
	"pay_apptrade": "https://vmp.eftpay.com.cn/VMP/wap/payPage?userkey=12345678&outTradeNo=20190824010716&sign=5c24f30f758d86e2ba1cc1a291aa6d392f563180584f071d2d725eff52947f05",
	"return_char": "",
	"transaction_amount": "0.02",
	"sign": "11c2d25ad95a8849a7598ca57b83731d0e2c2019710c7dd3feccbd8895d6d01c",
	"fee_type": "HKD",
	"tid": "",
	"eft_trade_no": "08520005269190824010701722",
	"out_trade_no": "20190824010716",
	"payType": "Alipay",
	"buyerType": "andriod",
	"return_status": "00",
	"time": "20190824010717"
}