alipay.fund.batch.create(批次下单接口) 在线调试(沙箱环境)

批量下单接口,收款方支持支付宝账户、银行卡、淘宝账户等。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.fund.batch.create
format String 40 仅支持JSON JSON
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_batch_no String 必选 32 商户的批次号 201801310127742502
product_code String 必选 64 业务产品码。不同产品值不同,具体值联系支付宝确认。 BATCH_PAY_V2
biz_scene String 必选 64 业务场景。不同场景值不同,具体值联系支付宝确认。 MESSAGE_BATCH_PAY
order_title String 必选 64 转账标题,用于收银台展示标题 报销付款
total_trans_amount Price 必选 16 批次总金额,单位为元,精确到小数点后两位,取值范围[0.01,9999999999999.99] 8.88
total_count String 必选 16 批次总笔数 10
payer_info Participant 可选 付款方信息
identity String 必填 64 参与方的唯一标识 2088123412341234
identity_type String 必填 64 参与方的标识类型,目前支持如下类型:
1、ALIPAY_USER_ID 支付宝的会员ID
2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式
ALIPAY_USER_ID
name String 可选 256 参与方真实姓名,如果非空,将校验收款支付宝账号姓名一致性。当identity_type=ALIPAY_LOGON_ID时,本字段必填。 黄龙国际有限公司
bankcard_ext_info BankcardExtInfo 特殊可选 2048 如果identity_type为BANKCARD_NO需传递该参数,涉及属性如下:
inst_name 银行卡卡开户银行
inst_province 银行所在省份
inst_city 银行所在市
inst_branch_name 收款银行所属支行
bank_code 银行卡支行联行号
account_type 银行卡账户类型 1:对公 2:对私
inst_name String 必填 64 机构名称 招商银行
account_type String 必填 1 收款账户类型。
1:对公(在金融机构开设的公司账户),如果银行卡为对公,必须传递省市支行信息或者联行号
2:对私(在金融机构开设的个人账户)
1
inst_province String 可选 64 银行所在省份 江苏省
inst_city String 可选 64 收款银行所在市 南京市
inst_branch_name String 可选 128 收款银行所属支行 新街口支行
bank_code String 可选 32 银行支行联行号 123456
merchant_user_info String 可选 2048 商户端的用户信息描述,目前可指定如下属性:
merchant_user_id:商户端的用户唯一ID
merchant_user_name:商户端的用户名
merchant_user_nickname:商户端的用户昵称
merchant_user_mobile:商户端的手机号
{"merchant_user_id":"123456"}
ext_info String 可选 2048 描述参与方信息的扩展属性,使用前请与支付宝工程师确认 {"alipay_anonymous_uid":"2088123412341234"}
time_expire String 可选 32 绝对超时时间,格式为yyyy-MM-dd HH:mm。 2018-03-23 19:15
trans_order_list TransOrderDetail[] 必选 收款信息列表
out_biz_no String 必填 64 商户订单号 2018999960760005838333
trans_amount String 必填 20 转账金额 20.11
payee_info Participant 必填 50 收款方信息
identity String 必填 64 参与方的唯一标识 2088123412341234
identity_type String 必填 64 参与方的标识类型,目前支持如下类型:
1、ALIPAY_USER_ID 支付宝的会员ID
2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式
ALIPAY_USER_ID
name String 可选 256 参与方真实姓名,如果非空,将校验收款支付宝账号姓名一致性。当identity_type=ALIPAY_LOGON_ID时,本字段必填。 黄龙国际有限公司
bankcard_ext_info BankcardExtInfo 特殊可选 2048 如果identity_type为BANKCARD_NO需传递该参数,涉及属性如下:
inst_name 银行卡卡开户银行
inst_province 银行所在省份
inst_city 银行所在市
inst_branch_name 收款银行所属支行
bank_code 银行卡支行联行号
account_type 银行卡账户类型 1:对公 2:对私
inst_name String 必填 64 机构名称 招商银行
account_type String 必填 1 收款账户类型。
1:对公(在金融机构开设的公司账户),如果银行卡为对公,必须传递省市支行信息或者联行号
2:对私(在金融机构开设的个人账户)
1
inst_province String 可选 64 银行所在省份 江苏省
inst_city String 可选 64 收款银行所在市 南京市
inst_branch_name String 可选 128 收款银行所属支行 新街口支行
bank_code String 可选 32 银行支行联行号 123456
merchant_user_info String 可选 2048 商户端的用户信息描述,目前可指定如下属性:
merchant_user_id:商户端的用户唯一ID
merchant_user_name:商户端的用户名
merchant_user_nickname:商户端的用户昵称
merchant_user_mobile:商户端的手机号
{"merchant_user_id":"123456"}
ext_info String 可选 2048 描述参与方信息的扩展属性,使用前请与支付宝工程师确认 {"alipay_anonymous_uid":"2088123412341234"}
order_title String 可选 64 转账订单的标题,用于在收银台和消费记录展示 报销-2918299
remark String 可选 256 转账备注,收、付款方均可见,收款方如果是支付宝账号,会展示在收款方账单里。 报销款201806
business_params String 可选 2048 JSON格式,传递业务扩展参数,使用前请与支付宝工程师联系!
sub_biz_scene: 子业务场景,取值:BAOXIAO\TRANSFER\...
withdraw_timeliness:到卡申请到账时效, T0:当日到账 T1:次日到账,如果未设置或者值为空默认T0
{"sub_biz_scene":"BAOXIAO","withdraw_timeliness":"T0"}
passback_params String 必填 256 JSON格式,传递业务扩展参数,使用前请与支付宝工程师联系! {"MERCHANT_PAYER_ID":"1234567890","MERCHANT_PAYER_PHONE:"15012341234"}
business_params String 可选 2048 JSON格式,传递业务扩展参数。 {"sub_biz_scene":"REDPACKET"}
passback_params String 可选 1024 公用回传参数,如果请求时传递了该参数,则异步通知商户时会回传该参数。 {"merchantBizType":"pay"}
remark String 可选 200 转账备注 发福利

响应参数

参数 类型 是否必填 最大长度 描述 示例值
out_batch_no String 必填 32 商户的批次号 201801310127742502
batch_trans_id String 必填 32 支付宝内部的批次ID 20190629110070001502040007320562
status String 必填 64 INIT:批次落单成功 INIT

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundBatchCreateRequest request = new AlipayFundBatchCreateRequest();
request.setBizContent("{" +
"\"out_batch_no\":\"201801310127742502\"," +
"\"product_code\":\"BATCH_PAY_V2\"," +
"\"biz_scene\":\"MESSAGE_BATCH_PAY\"," +
"\"order_title\":\"报销付款\"," +
"\"total_trans_amount\":8.88," +
"\"total_count\":\"10\"," +
"\"payer_info\":{" +
"\"identity\":\"208812*****41234\"," +
"\"identity_type\":\"ALIPAY_USER_ID\"," +
"\"name\":\"黄龙国际有限公司\"," +
"\"bankcard_ext_info\":{" +
"\"inst_name\":\"招商银行\"," +
"\"account_type\":\"1\"," +
"\"inst_province\":\"江苏省\"," +
"\"inst_city\":\"南京市\"," +
"\"inst_branch_name\":\"新街口支行\"," +
"\"bank_code\":\"123456\"" +
"      }," +
"\"merchant_user_info\":\"{\\\"merchant_user_id\\\":\\\"123456\\\"}\"," +
"\"ext_info\":\"{\\\"alipay_anonymous_uid\\\":\\\"2088123412341234\\\"}\"" +
"    }," +
"\"time_expire\":\"2018-03-23 19:15\"," +
"      \"trans_order_list\":[{" +
"        \"out_biz_no\":\"2018999960760005838333\"," +
"\"trans_amount\":\"20.11\"," +
"\"payee_info\":{" +
"\"identity\":\"208812*****41234\"," +
"\"identity_type\":\"ALIPAY_USER_ID\"," +
"\"name\":\"黄龙国际有限公司\"," +
"\"bankcard_ext_info\":{" +
"\"inst_name\":\"招商银行\"," +
"\"account_type\":\"1\"," +
"\"inst_province\":\"江苏省\"," +
"\"inst_city\":\"南京市\"," +
"\"inst_branch_name\":\"新街口支行\"," +
"\"bank_code\":\"123456\"" +
"          }," +
"\"merchant_user_info\":\"{\\\"merchant_user_id\\\":\\\"123456\\\"}\"," +
"\"ext_info\":\"{\\\"alipay_anonymous_uid\\\":\\\"2088123412341234\\\"}\"" +
"        }," +
"\"order_title\":\"报销-2918299\"," +
"\"remark\":\"报销款201806\"," +
"\"business_params\":\"{\\\"sub_biz_scene\\\":\\\"BAOXIAO\\\",\\\"withdraw_timeliness\\\":\\\"T0\\\"}\"," +
"\"passback_params\":\"{\\\"MERCHANT_PAYER_ID\\\":\\\"1234567890\\\",\\\"MERCHANT_PAYER_PHONE:\\\"15012341234\\\"}\"" +
"        }]," +
"\"business_params\":\"{\\\"sub_biz_scene\\\":\\\"REDPACKET\\\"}\"," +
"\"passback_params\":\"{\\\"merchantBizType\\\":\\\"pay\\\"}\"," +
"\"remark\":\"发福利\"" +
"  }");
AlipayFundBatchCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_batch_create_response": {
        "code": "10000",
        "msg": "Success",
        "out_batch_no": "201801310127742502",
        "batch_trans_id": "20190629110070001502040007320562",
        "status": "INIT"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TRANS_TOTAL_COUNT_ERROR 总笔数与明细汇总笔数不一致,请确认后重新请求 总笔数与明细汇总笔数不一致,请确认后重新请求
TOTAL_AMOUNT_NOT_MATCH 总金额与明细汇总金额不一致,请确认后重新输入 总金额与明细汇总金额不一致,请确认后重新输入
UNIQUE_VIOLATION 操作失败,该批次已经创建,请确认 操作失败,该批次已经创建,请确认
DAILY_QUOTA_LIMIT_EXCEED 今日转账金额已达上限,请尝试其它方式支付 今日转账金额已达上限,请尝试其它方式支付
MONTH_QUOTA_LIMIT_FAILURE 本月转账金额已达上限,请尝试其它方式支付 本月转账金额已达上限,请尝试其它方式支付
COUNT_MONTH_LIMIT_EXCEED 本月转账笔数已达上限,请尝试其它方式支付 本月转账笔数已达上限,请尝试其它方式支付
DETAIL_OUT_BIZ_NO_REPEATE 抱歉,当前明细中流水号重复,请确认后重试 抱歉,当前明细中流水号重复,请确认后重试
PAYER_USERINFO_STATUS_ERROR 付款账户异常,请确认后重试 付款账户异常,请确认后重试
PAYER_NOT_RELNAME_CERTIFY 付款账户未实名,请确认后重试 付款账户未实名,请确认后重试
PAYER_USERINFO_NOT_EXIST 付款账户不存在,请确认后重试 付款账户不存在,请确认后重试
PAYMENT_TIME_EXPIRE 支付请求已过期 支付请求已过期
REMARK_HAS_SENSITIVE_WORD 当前批次备注包含敏感用词,请修改后重试 当前批次备注包含敏感用词,请修改后重试
TRANS_TOTAL_COUNT_OVER_LIMIT 抱歉,明细支付笔数超过限制,请修改后重试 抱歉,明细支付笔数超过限制,请修改后重试
RESOURCE_LIMIT_EXCEED 请求超过资源限制 请求并发数超过支付宝处理速度,请降低请求并发数
ILLEGAL_ARGUMENT 非法参数 必填参数为空或者不符合要求,请检查
TRUSTEESHIP_ACCOUNT_NOT_EXIS 托管子户不存在 托管子户不存在,请检查
AUTH_CODE_ERROR 用户授权失败 用户授权失败,请检查
onlineServer