用户在商品下的额度查询接口

更新时间：2026-09-08 22:24:06

以 Markdown 格式查看 LLM请查看llms.txt

接口说明

接口名称：alipay.aipay.nowpay.quota.query

查询平台用户在指定额度包商品下的有效发放总额、已用额度和剩余额度。接口返回客观余额，平台根据自己的服务规则决定一次服务需要消耗多少次数或积分。

支持已获授权的第三方代理调用。所有接口由平台服务端调用。

适用场景

展示剩余次数或积分。
用户购买返回后刷新余额。
执行服务前进行余额预检查。

注意事项

仅适用于 QUANTITY；quota_unit 为 COUNT 或 POINT。
未购买时 total、used、remaining 都为 0；已用完时 remaining=0。统计仅覆盖当前纳入聚合的有效额度，不代表历史累计购买量。
查询只提供当前余额，不预占额度。并发消费场景必须以 quota.verify 的原子扣减结果为准。
购买后额度到账可能有短暂延迟。可以有限次刷新；尚未到账时提示稍后查询，不能仅凭余额未变化判定支付失败。

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
`app_id`	String	必选	32	支付宝分配给开发者的应用ID	`YOUR_APP_ID`
`method`	String	必选	128	接口名称	`alipay.aipay.nowpay.quota.query`
`format`	String	可选	40	仅支持JSON	`JSON`
`charset`	String	必选	10	请求使用的编码格式，如utf-8,gbk,gb2312等	`utf-8`
`sign_type`	String	必选	10	请求签名算法，推荐 RSA2	`RSA2`
`sign`	String	必选	344	商户请求参数的签名串，详见签名	`详见示例`
`timestamp`	String	必选	19	发送请求的时间，格式”yyyy-MM-dd HH:mm ”	`2026-09-07 10:00:00`
`version`	String	必选	3	调用的接口版本，固定为：1.0	`1.0`
`app_auth_token`	String	可选	40	已获授权的第三方代调用场景使用的应用授权令牌，详见应用授权概述	-
`biz_content`	String	必选	-	业务请求参数的 JSON 字符串，字段使用 snake_case；详见下表	-

业务请求参数

业务字段统一放入 biz_content。下表数组子字段使用 [] 表示元素路径。

参数	类型	是否必选	最大长度	描述	注意事项/枚举值	示例值
`out_product_id`	String	必选	128	平台内稳定的商品或应用标识	-	`app_writing_001`
`external_owner_id`	String	必选	128	平台内稳定的创作者或商品所有者标识	与配置时使用的标识一致；不是必须填写支付宝账号	`creator_001`
`external_buyer_id`	String	必选	128	平台内稳定的权益受益人标识	与平台登录用户绑定；不等同于付款账号	`user_001`

常见请求示例

示例商品、用户、域名及请求号均为演示值。Java 使用包含该接口请求类的支付宝服务端 SDK；示例按公钥模式初始化，私钥仅保存在平台服务端。cURL 中的签名需在发送前按全部实际参数生成；如增加 app_auth_token，应一起参与签名。

import com.alipay.api.AlipayConfig;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.request.AlipayAipayNowpayQuotaQueryRequest;
import com.alipay.api.response.AlipayAipayNowpayQuotaQueryResponse;

public class NowpayExample {
    public static void main(String[] args) throws Exception {
        AlipayConfig config = new AlipayConfig();
        config.setServerUrl("https://openapi.alipay.com/gateway.do");
        config.setAppId(System.getenv("ALIPAY_APP_ID"));
        config.setPrivateKey(System.getenv("ALIPAY_PRIVATE_KEY"));
        config.setAlipayPublicKey(System.getenv("ALIPAY_PUBLIC_KEY"));
        config.setFormat("json");
        config.setCharset("UTF-8");
        config.setSignType("RSA2");
        AlipayClient client = new DefaultAlipayClient(config);

        AlipayAipayNowpayQuotaQueryRequest request = new AlipayAipayNowpayQuotaQueryRequest();
        request.setBizContent("{\"out_product_id\":\"app_writing_001\",\"external_owner_id\":\"creator_001\",\"external_buyer_id\":\"user_001\"}");
        // 仅在已获授权的第三方代调用场景设置 app_auth_token。
        String appAuthToken = System.getenv("ALIPAY_APP_AUTH_TOKEN");
        if (appAuthToken != null && !appAuthToken.isEmpty()) {
            request.putOtherTextParam("app_auth_token", appAuthToken);
        }
        AlipayAipayNowpayQuotaQueryResponse response = client.execute(request);
        if (!response.isSuccess()) {
            // 按 code/sub_code 处理；结果未知时保留原业务请求号。
            System.out.println(response.getCode() + ":" + response.getSubCode());
            return;
        }
        // 网关成功后，按本页“结果处理”读取业务字段。
        System.out.println(response.getBody());
    }
}

biz_content='{
  "out_product_id": "app_writing_001",
  "external_owner_id": "creator_001",
  "external_buyer_id": "user_001"
}'

# app_id、timestamp、sign 由平台准备；sign 必须基于本次完整参数生成。
curl --request POST 'https://openapi.alipay.com/gateway.do' \
  --data-urlencode "app_id=${app_id}" \
  --data-urlencode 'method=alipay.aipay.nowpay.quota.query' \
  --data-urlencode 'format=json' \
  --data-urlencode 'charset=UTF-8' \
  --data-urlencode 'sign_type=RSA2' \
  --data-urlencode "timestamp=${timestamp}" \
  --data-urlencode 'version=1.0' \
  --data-urlencode "biz_content=${biz_content}" \
  --data-urlencode "sign=${sign}"

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
`code`	String	必选	-	网关返回码；10000 表示接口调用成功	`10000`
`msg`	String	必选	-	网关返回码说明	`Success`
`sub_code`	String	可选	-	业务错误码；仅用于接口失败处理	-
`sub_msg`	String	可选	-	业务错误说明；不用于编写固定业务分支	-
`sign`	String	必选	-	响应签名，位于响应根对象；由 SDK 按配置验签	-

响应业务对象名为 alipay_aipay_nowpay_quota_query_response。先完成验签并判断 code，再读取业务结果。

业务响应参数

参数	类型	是否必选	最大长度	描述	注意事项/枚举值	示例值
`quota_unit`	String	必选	32	次数或积分`COUNT`/`POINT`	`COUNT`：次数；`POINT`：积分	`COUNT`
`total`	Number	必选	32	当前纳入聚合的有效发放额度，单位次数或积分个数	-	`20`
`used`	Number	必选	32	上述有效发放额度中的已使用量,单位次数或积分个数	-	`0`
`remaining`	Number	必选	32	当前可消费余额，单位次数或积分个数	-	`20`
`as_of_time`	String	必选	32	余额计算时间；格式 `yyyy-MM-dd HH:mm:ss`，时区 `Asia/Shanghai`	-	`2026-09-07 10:00:00`

结果处理

平台根据 quota_unit 展示次数或积分，按 remaining 做服务前置判断。余额充足仍需核销；不足时可调用获取购买链接。返回 0 余额本身是正常查询结果，不作为接口失败。

响应示例

以下为按单一业务场景整理的示例。签名、链接令牌和二维码均为占位值，不可直接使用。

{
  "alipay_aipay_nowpay_quota_query_response": {
    "code": "10000",
    "msg": "Success",
    "quota_unit": "COUNT",
    "total": 20,
    "used": 0,
    "remaining": 20,
    "as_of_time": "2026-09-07 10:00:00"
  },
  "sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}

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

公共错误码

参见支付宝公共错误码。网关或系统异常时，按原请求查询或重试；写操作不能在结果未确认时更换幂等号。

业务错误码

以下保留当前开放平台预览已列出的错误码，并补充平台处理建议。错误码列表可能扩展，平台应保留未知错误的待确认处理。

错误码	错误描述	解决方案
`SYSTEM_ERROR`	系统繁忙	稍后使用原参数重试；消费结果未知时先查询原请求
`INVALID_PARAMETER`	参数有误	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试
`BILLING_MODE_NOT_SUPPORTED`	商品不是额度包模式	请核对入参参数相关的商品配置信息