网银支付API

数据格式

请求网易支付和通知商户的接口采用统一的参数定义规则:

参数

参数名称

长度

必填

样例

sign

根据msg和算法签名后的字符

String

是


msg

消息体,根据“业务参数”列表,拼装而成的消息体

String

是


msgType

消息类型,XML,JSON

String

是

XML

callerPlatformId

 (最大长度40个英文字符)

 调用方商户号(共享平台主平台商户号)

String

是

20153322333333

比如:https://epay.163.com/api/pay_trade_service.htm?msg=&sign&msgType=&callerPlatformId=,其中msg,msgType,callerPlatformId和sign是必填参数。所有参数只存在一级节点中,不采用多级节点嵌套请求编码方式必须为utf-8。

1 下单API

接口调用URL

https://epay.163.com/api/pay_trade_service.htm?msg=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48ZXBheT48dmVyc2lvbj4xLjA8L3ZlcnNpb24+PHNpZ25fdHlwZT5yc2E8L3NpZ25fdHlwZT48Z29vZHNfbmFtZT7lvannpag8L2dvb2RzX25hbWU+PGdvb2RzX3VybD5odHRwOi8vY2FpcGlhby4xNjMuY29tL29yZGVyL3ByZUJldF9zc3EuaHRtbDwvZ29vZHNfdXJsPjx0cmFkZV9hbW91bnQ+MC4wMTwvdHJhZGVfYW1vdW50PjxwbGF0Zm9ybV9pZD4yMDA4MTIyODE1UFQwMDAwMDAyNTwvcGxhdGZvcm1faWQ+PHBsYXRmb3JtX3RyYWRlX2lkPjIwMTIwNzAzMTdDUDAwMDAwMDAxPC9wbGF0Zm9ybV90cmFkZV9pZD48cGxhdGZvcm1fdXNlcl9pcD4xMjcuMC4wLjE8L3BsYXRmb3JtX3VzZXJfaXA+PHRyYWRlX3R5cGU+MTwvdHJhZGVfdHlwZT48cGxhdGZvcm1fdHJhZGVfdGltZT4yMDEyMDgwMiAxODoxMTowMDwvcGxhdGZvcm1fdHJhZGVfdGltZT48bm90aWZ5X3VybD5odHRwOi8vY2FpcGlhby4xNjMuY29tL29yZGVyL3ByZUJldF9zc3EuaHRtbDwvbm90aWZ5X3VybD48dGltZW91dD4xMjA8L3RpbWVvdXQ+PHBsYXRmb3JtX3ByaXZhdGVfZmllbGQ+dGVzdDwvcGxhdGZvcm1fcHJpdmF0ZV9maWVsZD48L2VwYXk+&msgType=xml&sign=123


下单参数

字段名

参数名

必填

长度

样例

版本号

version

是

varchar2(8)

1.0.0

操作名称

action

是

varchar2(30)

pay_trade_service

请求类型

operation

是

varchar2 (30)

addTrade

商品名

goodsName

是

varchar2(150)

考拉

商品URL

goodsUrl

是

varchar2(300)

下单商品url

支付金额

tradeAmount

是

varchar2(13)

0.01

平台商户ID

platformId  

是

varchar2(40)   

商户号,原样返回    ,如:2008122815PT00000025 

调用平台商户ID

callerPlatformId

是

varchar2(40)   

共享签约时调用方平台商户号,原样返回。(共享平台传主平台商户号), 如果是多平台的情况, 传递该值。

商户交易流水号

platformTradeId

是

varchar2(40)

唯一

交易类型 
  
 

tradeType

是

varchar2(2)

1:即时 
  3
:网关支付交易 
  5
:捐赠 

物流类型
  
 

logisticsType

否

 int

0:虚拟 
  1:
平邮 
  2:
快递

网关支付时物流类型可不传 ,否则必传

商户商品交易时间

platformTradeTime

是

 varchar2(40)

格式yyyyMMddHHmmss 
  
若时间超过当前时间三个月以上,则拒绝下单

通知平台的URL

notifyUrl

是

varchar2(300)

前后台通知都是该参数

交易超时时间 
  
 

timeout

否

 varchar2(40)

必须是非零的整数。为正整数时单位为分钟.。为负整数代表单位为毫秒。

该参数可选, 若不传则按照网易支付中设定的超时时间规则确定交易的超时时间。

若超时时间超过一个月,默认将超时时间设置为一个月

平台保留字段

platformPrivateField

否

varchar2(300)

存放需要原样返回给平台的信息;如果没有,则不需要传

货币类型

currencyType

是

varchar2(2)

00:人民币

卖家账户sellerId否varchar2(60)卖家账户, 
如果是交易类型是网关支付不用传

平台订单URL

platformTradeUrl

否

varchar2(300)

用于显示平台订单的详细信息

付款方账户idpayAccountId否
varchar2(40)付款方账户id,交易类型非网关单, 必传

商品类目

category

否

varchar2(8)

见商品类目代码表

用户IP

userIp

否

varchar(20)

127.0.0.1

用户Mac地址

macAddr

否

varchar(30)


用户cpu号

cpuSerial

否

varchar(80)


用户硬盘号

hddSerial

否

varchar(80)


用户设备唯一识别码 

uniqCode

否

varchar(60)


订单额外信息

extraInfo

否

varchar(1000)

需要base64编码后再签名和传输

见风控信息

前端跳转地址

frontReturnUrl

否

varchar(300)

仅对单笔下单生效,在做前端页面跳转时跳转到该地址,通知参数不变。不传或为空时前端仍旧跳转到notifyUrl

 

返回参数

参数名称

参数

是否为空

样例

处理结果报文 

msg

如果下单失败为空


Msg签名信息 

sign

如果下单失败为空


返回码

operationCode

不为空

1000

错误内容

errorMsg

如果下单失败, 错误详细信息, 如果下单成功为空 

msg_is_null

msg中的参数说明


参数

参数名称

样例

orderId

网易支付订单号

2012120115JY15594404

platformId

商户平台ID,原样返回

2009061117PT25762148

platformPrivateField

平台保留字段,存放需要原样返回给平台的信息, 
  
如果没有,则不需要传

test

callerPlatformId

共享签约中主平台商户号, 当该主平台商户号存在的时候, platformId和platformPrivateField 均为多值,platformId以|分割, platformPrivateField以||分割

2009061117PT25762148

token

后台返回流水号

目前用于ApplePay获取银联TN号 



2 支付API

接口调用示例

https://epay.163.com/api/pay_trade_service.htm?

.msg=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48ZXBheT48dmVyc2lvbj4xLjA8L3ZlcnNpb24+PHNpZ25fdHlwZT5yc2E8L3NpZ25fdHlwZT48Z29vZHNfbmFtZT7lvannpag8L2dvb2RzX25hbWU+PGdvb2RzX3VybD5odHRwOi8vY2FpcGlhby4xNjMuY29tL29yZGVyL3ByZUJldF9zc3EuaHRtbDwvZ29vZHNfdXJsPjx0cmFkZV9hbW91bnQ+MC4wMTwvdHJhZGVfYW1vdW50PjxwbGF0Zm9ybV9pZD4yMDA4MTIyODE1UFQwMDAwMDAyNTwvcGxhdGZvcm1faWQ+PHBsYXRmb3JtX3RyYWRlX2lkPjIwMTIwNzAzMTdDUDAwMDAwMDAxPC9wbGF0Zm9ybV90cmFkZV9pZD48cGxhdGZvcm1fdXNlcl9pcD4xMjcuMC4wLjE8L3BsYXRmb3JtX3VzZXJfaXA+PHRyYWRlX3R5cGU+MTwvdHJhZGVfdHlwZT48cGxhdGZvcm1fdHJhZGVfdGltZT4yMDEyMDgwMiAxODoxMTowMDwvcGxhdGZvcm1fdHJhZGVfdGltZT48bm90aWZ5X3VybD5odHRwOi8vY2FpcGlhby4xNjMuY29tL29yZGVyL3ByZUJldF9zc3EuaHRtbDwvbm90aWZ5X3VybD48dGltZW91dD4xMjA8L3RpbWVvdXQ+PHBsYXRmb3JtX3ByaXZhdGVfZmllbGQ+dGVzdDwvcGxhdGZvcm1fcHJpdmF0ZV9maWVsZD48L2VwYXk+&msgType=xml&sign=123


调用参数


字段名

参数名

必传 

类型 

描述

版本号

version

是

8

1.0.0

操作名称

action

是

30

pay_trade_service

请求类型

operation

是

30

pc付款:payTrade;

mobile付款: mobilePayTrade;

银行代码

payMethod

否

10

如果传递可以直接定位到对应银行页面

见bankID

网易支付订单号

orderId

是

40

如:2012112916JY15592132

商户平台ID

platformId

是

40

商户号,原样返回

商户引导到网易支付支付时间 

platformPayTime 

是

14

网易支付会校验该时间与当前时间相差范围, 如果超过10分钟则不允许支付,超时时间可配置

如:20120910000000



3 支付成功通知API

参见支付成功异步通知接口文档