alipay.fund.trans.app.pay(现金红包无线支付接口) 在线调试(沙箱环境)

外部商户APP唤起快捷SDK创建现金红包单据并进行支付

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.fund.trans.app.pay
format String 40 仅支持JSON JSON
return_url String 256 HTTP/HTTPS开头字符串 https://m.alipay.com/Gk8NF23
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_biz_no String 必选 64 商户端的唯一订单号,对于同一笔转账请求,商户需保证该订单号唯一。 2018062800001
trans_amount Price 必选 16 订单总金额,单位为元,精确到小数点后两位,取值范围[0.01,9999999999999.99] 8.88
product_code String 必选 64 销售产品码,商家和支付宝签约的产品码。
STD_RED_PACKET:现金红包
STD_RED_PACKET
biz_scene String 必选 64 描述特定的业务场景,可传值如下:
PERSONAL_PAY: 发红包
PERSONAL_PAY
remark String 可选 200 支付备注 拼手气红包
order_title String 可选 128 支付订单的标题,用于在收银台和消费记录展示 钉钉拼手气红包
time_expire String 可选 16 绝对超时时间,格式为yyyy-MM-dd HH:mm 2018-03-23 19:15
refund_time_expire String 可选 16 退款超时时间,格式yyyy-MM-dd HH:mm。到指定时间后,系统会自动触发退款,并原路退回到付款账户。如果指定了退款时间,必须早于销售方案里设置的最晚退款时间。 2018-11-08 10:00
business_params String 可选 2048 JSON格式,传递业务扩展参数.
业务扩展字段,JSON格式。支持如下属性:
sub_biz_scene 子场景,必填,传REDPACKET
payer_binded_alipay_id 创建红包的商户会员绑定的支付宝userId,必填
{"sub_biz_scene":"REDPACKET","payer_binded_alipay_uid:"2088302510459335"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
out_biz_no String 必填 64 商户端的唯一订单号 201806300001
order_id String 选填 32 该笔转账在支付宝系统内部的单据ID 20180629110070001502040007320562
status String 选填 64 SUCCESS:转账成功;
WAIT_PAY:转账订单等待支付;
CLOSED:订单超时关闭,截止订单支付超时时间(time_expire)仍未支付,单据状态会变更为CLOSED;
SUCCESS

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundTransAppPayRequest request = new AlipayFundTransAppPayRequest();
request.setBizContent("{" +
"\"out_biz_no\":\"2018062800001\"," +
"\"trans_amount\":8.88," +
"\"product_code\":\"STD_RED_PACKET\"," +
"\"biz_scene\":\"PERSONAL_PAY\"," +
"\"remark\":\"拼手气红包\"," +
"\"order_title\":\"钉钉拼手气红包\"," +
"\"time_expire\":\"2018-03-23 19:15\"," +
"\"refund_time_expire\":\"2018-11-08 10:00\"," +
"\"business_params\":\"{\\\"sub_biz_scene\\\":\\\"REDPACKET\\\",\\\"payer_binded_alipay_uid:\\\"2088302510459335\\\"}\"" +
"  }");
AlipayFundTransAppPayResponse response = alipayClient.pageExecute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_trans_app_pay_response": {
        "code": "10000",
        "msg": "Success",
        "out_biz_no": "201806300001",
        "order_id": "20180629110070001502040007320562",
        "status": "SUCCESS"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_fund_trans_app_pay_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误参数有误 参数校验失败
PAYEE_NOT_EXIST 收款方不存在 收款方不存在
onlineServer