alipay.fund.account.query(支付宝资金账户资产查询接口) 在线调试(沙箱环境)

可查询支付宝资金账户资产,如钉钉零钱包的钉钉用户托管子户余额查询。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
alipay_user_id String 必选 28 蚂蚁统一会员ID 2088301409188095
merchant_user_id String 特殊可选 64 商户会员的唯一标识。如果传入的user_id为虚拟账户userId,此字段必传并比对一致性。 243893499
account_product_code String 特殊可选 32 开户产品码。如果查询托管子户余额,必传且必须传入与开户时传入的值一致。 DING_ACCOUNT
account_type String 特殊可选 30 查询的账号类型,如查询托管账户值为TRUSTEESHIP_ACCOUNT,查询余额账户值为ACCTRANS_ACCOUNT。查询余额账户时必填。 TRUSTEESHIP_ACCOUNT
account_scene_code String 特殊可选 32 开户场景码,与开户产品码不可同时传递。 SCENE_000_000_000
ext_info String 可选 1024 JSON格式,传递业务扩展参数。 {"agreement_no":"2019000000000"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
available_amount String 必填 15 可用余额。可用于支付或提现的余额。 26.45
ext_card_info ExtCardInfo 选填 场景余额模式外标卡信息
card_no String 必填 64 托管子户的外卡卡号 2088881500000002150
bank_acc_name String 必填 64 托管子户外卡户名 xxx208888
card_branch String 必填 128 托管子户外卡支行 支付宝-备付金账户
card_bank String 必填 128 托管子户外卡开户行 支付机构备付金集中存管账户
card_location String 可选 128 托管子户外卡开户地址 上海市-上海市
card_deposit String 可选 64 托管子户外卡联行号 991290000015
status String 必填 10 托管子户外卡状态 1

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundAccountQueryRequest request = new AlipayFundAccountQueryRequest();
request.setBizContent("{" +
"\"alipay_user_id\":\"2088301409188095\"," +
"\"merchant_user_id\":\"243893499\"," +
"\"account_product_code\":\"DING_ACCOUNT\"," +
"\"account_type\":\"TRUSTEESHIP_ACCOUNT\"," +
"\"account_scene_code\":\"SCENE_000_000_000\"," +
"\"ext_info\":\"{\\\"agreement_no\\\":\\\"2019000000000\\\"}\"" +
"  }");
AlipayFundAccountQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_account_query_response": {
        "code": "10000",
        "msg": "Success",
        "available_amount": "26.45",
        "ext_card_info": {
            "card_no": "2088881500000002150",
            "bank_acc_name": "xxx208888",
            "card_branch": "支付宝-备付金账户",
            "card_bank": "支付机构备付金集中存管账户",
            "card_location": "上海市-上海市",
            "card_deposit": "991290000015",
            "status": "1"
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 参数有误 参数有误,请根据接口文档检查请求参数
SYSTEM_ERROR 系统繁忙 请原始请求重试。多次重试无用后,请联系支付宝技术支持咨询。
NO_PERMISSION_ACCOUNT 无权限操作当前付款账号 无权限操作当前付款账号
TRUSTEESHIP_ACCOUNT_NOT_EXIST 托管子户查询不存在 托管子户查询不存在
USER_AGREEMENT_VERIFY_FAIL 用户协议校验失败 请检查用户协议号是否正确
onlineServer