alipay.fund.batch.close(批量转账关单接口) 在线调试(沙箱环境)

批量转账关单接口,在批次下单但没支付情况下可以通过该接口关闭批次。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.fund.batch.close
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_code String[] 可选 64 业务产品码。不同产品值不同,具体值联系支付宝确认。 BATCH_PAY_V2
biz_scene String 必选 64 业务场景。不同场景值不同,具体值联系支付宝确认。 MESSAGE_BATCH_PAY
batch_trans_id String 可选 32 支付宝内部的批次ID: 本参数和商户的批次号两者不能同时为空。 当本参数和商户的批次号两者同时提供时,将优先用商户的批次号进行查询。 201801310127742502

响应参数

参数 类型 是否必填 最大长度 描述 示例值
batch_trans_id String 必填 32 支付宝内部的批次ID 201801310127742502
status String 必填 64 DISUSE:批次废弃 DISUSE

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundBatchCloseRequest request = new AlipayFundBatchCloseRequest();
request.setBizContent("{" +
"      \"product_code\":[" +
"        \"BATCH_PAY_V2\"" +
"      ]," +
"\"biz_scene\":\"MESSAGE_BATCH_PAY\"," +
"\"batch_trans_id\":\"201801310127742502\"" +
"  }");
AlipayFundBatchCloseResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_batch_close_response": {
        "code": "10000",
        "msg": "Success",
        "batch_trans_id": "201801310127742502",
        "status": "DISUSE"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_ARGUMENT 非法参数 必填参数为空或者不符合要求,请检查
NO_SIGN_PRODUCT 产品未签约 请签约产品之后再使用该接口
BATCH_ID_IS_NOT_EXIT 批次ID参数无效 请更改为有效的批次ID
BATCH_ORDER_STATUS_INVALID 批次状态不合法 批次状态不合法
onlineServer