创建 Withdrawal 对象

通过调用该接口发起一笔用户提现申请,提现申请表示用户提现意图,不会真实发起付款行为,需要后续确认。注:微信服务商模式商户暂不支持提现。

请求参数描述
APP_ID required string对应 app 对象的 id,该参数仅需要填写在请求地址内,查看 如何获取App ID
user required stringuser 对象的 id
amount required int提现扣除的余额,单位为分,取值范围 1~1000000000。
channel required string提现使用的付款渠道:wx(微信 App)、wx_pub(微信公众号)、wx_lite(微信小程序)、alipay(支付宝)、 unionpay(银联)、allinpay(通联)和 jdpay(京东)。此外,还支持使用自定义渠道 custom,该渠道不需要真实付款,并在确认提现时同步返回成功结果。
order_no required string提现使用的商户订单号。wx/wx_pub/wx_lite 规定为 1 ~ 32 位不能重复的数字字母组合; alipay 为 1 ~ 64 位不能重复的数字字母组合;unionpay 为 1 ~ 16 位的纯数字; allinpay 为 20 ~ 40 位不能重复的数字字母组合,必须以签约的通联的商户号开头(建议组合格式:通联商户号 + 时间戳 + 固定位数顺序流水号,不包含+号)。
description required string附加说明,最多 60 个 Unicode 字符。渠道为 jdpay、alipay、unionpay、wx、wx_pub、wx_lite 时,最多 60 个字节或 20 个 Unicode 字符;渠道为 allinpay 时,最多 30 个 Unicode 字符。
user_fee optional int需要用户承担的手续费,单位为分。
extra optional hash相关的附加参数,详见下方 extra 参数说明
metadata optional hash详见 元数据
settle_account optional string用户结算账户 settle_account 对象 ID。传入此参数时将使用结算账户提现,不需要填写 extra 参数。同时填写 extra 时,此参数不生效。

extra 参数说明

alipay 渠道
参数描述
account required string接收者支付宝账号。
type optional string付款类型,分为两种: "b2c" :企业向个人付款, "b2b" :企业向企业付款。不传时默认为 "b2c" 类型。
name required string收款人姓名。
account_type optional string收款方账户类型。默认值:"ALIPAY_LOGONID"。ALIPAY_USERID:支付宝账号对应的支付宝唯一用户号,以 2088 开头的 16 位纯数字组成;ALIPAY_LOGONID:支付宝登录号,支持邮箱和手机号格式。

wx、wx_pub、wx_lite 渠道
参数描述
open_id required string提现用户在微信平台下的 open_id。点此参考如何获取open_id
type optional string付款类型,目前仅支持 "b2c" :企业向个人付款。
name optional string收款人姓名。
force_check optional boolean是否强制校验收款人姓名。仅当 name 参数不为空时该参数生效。

allinpay 渠道
参数描述
account required string收款人银行卡号或者存折号。
type optional string付款类型,分为两种: "b2c" :企业向个人付款, "b2b" :企业向企业付款。不传时默认为 "b2c" 类型。
name required string收款人姓名。
open_bank_code required string4位开户银行编号,详情请参考通联代付银行编号说明
business_code optional string5位业务代码,根据通联业务人员提供,不填则使用通联提供默认值为 "09900"。详情请参考通联代付业务代码说明
card_type optional int银行卡号类型,0:银行卡;1:存折,默认值为 "0"。
sub_bank conditional,stringB2B 提现必填,1~80位,开户行详细名称,也叫网点,如:中国建设银行广州东山广场分理处。详情请下载 支付行号
sub_bank_code conditional,stringB2B 提现必填,1~12位,支付行号。详情请下载 支付行号
prov conditional,stringB2B 提现必填,1~20位,省份,不带 “省” 或 “自治区”,需填写成:广东、广西、内蒙古等。详情请参考 中国邮政区号表 内的「省洲名称」列的内容填写。
city conditional,stringB2B 提现必填,1~40位,城市,不带 “市”,需填写成:广州、南宁等。如果是直辖市,则填区,如北京(市)朝阳(区)。详情请参考 中国邮政区号表 内的「地区名称」列的内容填写。

jdpay 渠道
参数描述
account required string收款人银行卡号或者存折号。
type optional string付款类型,分为两种: "b2c" :企业向个人付款, "b2b" :企业向企业付款。不传时默认为 "b2c" 类型。
name required string收款人姓名。
open_bank_code required string开户银行编号。

unionpay 渠道
参数描述
account required string1~32位,收款人银行卡号或者存折号。
type optional string付款类型,分为两种: "b2c" :企业向个人付款, "b2b" :企业向企业付款。不传时默认为 "b2c" 类型。
name required string1~100位,收款人姓名。
open_bank_code optional string4位,开户银行编号,详情请参考银联电子代付银行编号说明
open_bank optional string1~50位,开户银行。
prov optional string1~20位,省份。
city optional string1~40位,城市。
sub_bank optional string1~80位,开户支行名称。

注:open_bank_codeopen_bank 两个参数必传一个,建议使用 open_bank_code ,若都传参则优先使用 open_bank_code 读取规则;provcity 均为可选参数,如果不传参,则使用默认值 "上海" 给渠道接口。


custom 渠道
参数描述
type optional string付款类型,分为两种: "b2c" :企业向个人付款, "b2b" :企业向企业付款。不传时默认为 "b2c" 类型。

返回

返回一个 withdrawal 提现对象,或者返回一个错误,详见 错误

定义

POST https://api.pingxx.com/v1/apps/{APP_ID}/withdrawals
待补充
待补充
待补充
待补充
待补充
待补充
待补充

请求示例

curl https://api.pingxx.com/v1/apps/app_1Gqj58ynP0mHeX1q/withdrawals \
-H "Pingplusplus-Signature: {SIGNATURE}" \
-H "Pingplusplus-Request-Timestamp: 1478833871" \
-u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC: \
-d '{
    "amount": 20000,
    "user": "user_001",
    "order_no": "20160829133002",
    "user_fee": 50,
    "description": "test232description",
    "channel": "unionpay",
    "extra": {
        "account": "6225210207073918",
        "name": "姓名",
        "open_bank_code": "0102",
        "prov": "上海",
        "city": "上海"
    }
}'
待补充
待补充
待补充
待补充
待补充
待补充
待补充

返回示例

{
    "id": "1701611150302360654",
    "object": "withdrawal",
    "app": "app_LibTW1n1SOq9Pin1",
    "amount": 20000,
    "asset_transaction": "",
    "balance_transaction": "",
    "channel": "unionpay",
    "created": 1472648887,
    "description": "test232description",
    "extra": {
        "account": "6225210207073918",
        "name": "姓名",
        "open_bank_code": "0102",
        "prov": "上海",
        "city": "上海"
    },
    "fee": 200,
    "livemode": true,
    "metadata":{},
    "order_no": "20160829133002",
    "source": null,
    "status": "created",
    "time_canceled": null,
    "time_succeeded": null,
    "user_fee": 50
}