商户提现API

接口说明

商户提现功能,网易支付会从商户余额中扣除对应的提现金额,提现请求发送时请保证余额充足,否则会提示余额不足。

提现到账时间:一般工作日2小时内到账,非工作日银行不处理。具体请参考:提现到账时间


数据格式

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

参数

参数名称

长度

必填

样例

sign

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

String


msg

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

String


msgType

消息类型,XML,JSON

String

XML

比如:https://epay.163.com/api/platform_withdraw_action.htm?msg=&sign=&msgType=,其中msg、msgType和sign是必填参数。如果有特殊字符为避免请求被转码等问题,每个参数发送时需进行UrlEncode。所有参数只存在一级节点中,不采用多级节点嵌套请求编码方式必须为utf-8。


1 提现API(PlatformWithdraw)

请求URL

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

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


调用参数

参数名称

参数

必填 

长度 

样例

版本号

version

8

1.0.0

操作名称

action

30

platform_withdraw_action(固定值)

商户平台ID

platformId

40

商户号2008122815PT00000025  

商户提现流水

platformWithDrawId

40

2012070317CP00000001  

(需保证不会重复)

商户提现日期

platformWithDrawDate   

14

20131203120000

格式:yyyyMMddHHmmss

提现金额

withDrawAmount

12

金额必须为正数,最大为9999999999.99,小数点后最多精确两位

收款快捷卡ID

quickPayId

40

如果传了quickPayIdaccountId,则根据用户绑定快捷卡信息进行收款,不必再传下面的银行卡信息

收款用户账号

accountId

40

如果传了quickPayIdaccountId,则根据用户绑定快捷卡信息进行收款,不必再传下面的银行卡信息

用户账号类型

accountType

40

指定quickPayIdaccountId时使用该字段,urs账号则传urs,其它则传outer,默认outer

只能填ursouter或不传,不要传空字符串

收款银行户名

bankAccountName

100

测试

收款银行账号

bankAccountId

60

Aaaaaaaa

通过AES加密,加密后的字节数组转字符串使用base64编码)

收款银行所在市id cityId8

1,若quickpayId为空,且enterpriseFlag=true,表示对公提现,cityId必传

cityId

收款开户银行id 

bankId

8

14 见bankID

货币类型

currencyType

2

00:人民币,暂时只支持人民币  

对公提现标志位 

enterpriseFlag

5

对公对私标识,E标识对公,为空表示对私

提现终端

term

10

PCAPPWAP

业务类型bizType60特殊业务类型由产品签约时对接的商务告知,默认为普通业务类型。

开户银行名

openBankName

50

上海农商银行堡镇支行

开户银行号

openBankNo

20

322290010201 
  
注意:对公提现必须填开户银行名或开户银行号(开户银行名和开户银行号任选其一即可)。

提现备注

memo

50

商户提现备注

返回参数

参数名称

参数

是否为空

样例

处理结果报文 

msg

如果下单失败为空


Msg签名信息 

sign

如果下单失败为空

Y1tn97FXldNeUs3+jiGoPn   

返回码

operationCode

不为空

1000

错误内容

errorMsg

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

msg_is_null


Msg
中的参数说明

参数

参数名称

必填 

platformId

商户平台ID(商户号)

platformWithDrawId

商品提现流水(需保证不会重复)

platformWithDrawDate   

商品提现日期 
  yyyyMMddhhmmss

withDrawAmount

提现金额

handlingFee

手续费

withdrawStatus

处理状态 
  1
:已经成功发送  
  3
:网易支付已经受理 
  2
:失败,不需要退手续费 
  5
:提现失败,已经返还过提现手续费和提现金额给用户 
  6
:提现失败,但是已经返回过手续费 
  7
:提现失败,网易支付导致

(如果已经存在提现记录,会返回当前提现记录的状态)

withDrawBackReason

提现失败原因(提现失败时候才有值)

 

提现失败通知API

提现失败通知url即商户提现接口权限配置项的回调url,使用POST请求。

注意:

1.如果商户收到网易支付提现失败通知的请求,打印platformId|platformWithDrawId给网易支付,否则网易支付则会一直发送通知给商户。

2.如果商户端设置了IP访问白名单,商户需要在白名单中新增下列ip:

    a. 59.111.18.0 ~ 59.111.18.254,255个IP

    b. 123.58.185.40,123.58.185.30,123.58.185.57,123.58.185.56,123.58.185.25 

网易支付出口ip列表


通知参数

网易支付通知商户提现失败参数

参数

参数名称

msg

处理结果报文 

sign

Msg签名信息 

Msg中的参数说明

参数

参数名称

必填 

platformId

商户平台ID(商户号)

platformWithDrawId

商品提现流水(需保证不会重复)

platformWithDrawDate   

商品提现日期 
  yyyyMMddhhmmss

withDrawAmount

提现金额

handlingFee

手续费

withdrawStatus

处理状态   
  2
:失败,不需要退手续费 
  5
:提现失败,已经返还过提现手续费和提现金额给用户 
  6
:提现失败,但是已经返回过手续费 
  7
:提现失败,网易支付导致

withDrawBackReason

提现失败原因


3 提现成功通知API

由于部分渠道在发送成功提现后,仍可能出现提现失败,并发送提现失败通知;请以失败通知为准;  本通知使用场景请商户酌情处理;

提现成功通知通知url为提现成功通知权限配置项的回调url,使用POST请求

注意:

1.如果商户收到网易支付提现成功通知的请求,打印platformId|platformWithDrawId给网易支付,否则网易支付则会一直发送通知给商户。

2.如果商户端设置了IP访问白名单,商户需要在白名单中新增下列ip:

    a. 59.111.18.0 ~ 59.111.18.254,255个IP

    b. 123.58.185.40,123.58.185.30,123.58.185.57,123.58.185.56,123.58.185.25 

网易支付出口ip列表

通知参数

网易支付通知商户提现成功参数

参数
参数名称
样例

msg

处理结果报文

PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9In

sign

msg签名信息

Y1tn97FXldNeUs3+jiGoPn


Msg中的参数说明

参数
参数说明
必填

platformId

商户平台ID

platformWithDrawId

商品提现流水(需保证不会重复)

platformWithDrawDate

商品提现日期 
yyyyMMddHHmmss

withDrawAmount

提现金额

handlingFee

手续费

withdrawStatus

1:提现成功记录

withDrawBackReason

提现失败原因,成功通知不显示

receiveFlag银行确认标识 
当withdrawStatus=1,且receiveFlag=Y时表示款项已到账,其他情况表示未到账 
在一些特殊情况下,此标识不一定100%准确