用户是否拥有商品权益查询接口
更新时间:
接口说明
接口名称:alipay.aipay.nowpay.purchase.consult
查询指定平台用户是否拥有可使用的买断或时长包权益。返回访问决策;需要购买且商品可购买时,同时返回支付宝托管购买页入口。
适用场景
- 买断或时长包用户进入付费功能前校验访问权限。
- 用户从支付页返回后重新确认权益。
- 时长包需要展示当前权益有效期。
注意事项
- 仅适用于
ONE_TIME和ONE_TIME_DURATION。QUANTITY商品应使用quota.query,并在消费时调用quota.verify。 - 只有 decision=
ALLOW才放行。PURCHASE_REQUIRED引导用户使用返回的购买入口;DENY不放行、不展示新的购买入口。 callback_url只表示页面返回。用户返回后必须再次查询本接口;不要根据跳转、前端参数或本地缓存认定支付和权益成功。- 时长包有效区间为 [
valid_from,valid_until),到达valid_until后不再有效;永久买断不返回这两个时间字段。已有有效买断或时长权益时不引导再次购买。 - 商品停止新增购买后,已有有效权益仍可能返回
ALLOW。放行以 decision 为准,不能仅按capability_status决定。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用ID | YOUR_APP_ID |
method | String | 必选 | 128 | 接口名称 | alipay.aipay.nowpay.purchase.consult |
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 |
callback_url | String | 可选 | 512 | 购买完成返回地址 | 页面返回地址,不是异步通知地址;返回后重新查询状态 | https://platform.example.com/nowpay/purchase-return |
常见请求示例
示例商品、用户、域名及请求号均为演示值。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.AlipayAipayNowpayPurchaseConsultRequest;
import com.alipay.api.response.AlipayAipayNowpayPurchaseConsultResponse;
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);
AlipayAipayNowpayPurchaseConsultRequest request = new AlipayAipayNowpayPurchaseConsultRequest();
request.setBizContent("{\"out_product_id\":\"app_writing_001\",\"external_owner_id\":\"creator_001\",\"external_buyer_id\":\"user_001\",\"callback_url\":\"https://platform.example.com/nowpay/purchase-return\"}");
// 仅在已获授权的第三方代调用场景设置 app_auth_token。
String appAuthToken = System.getenv("ALIPAY_APP_AUTH_TOKEN");
if (appAuthToken != null && !appAuthToken.isEmpty()) {
request.putOtherTextParam("app_auth_token", appAuthToken);
}
AlipayAipayNowpayPurchaseConsultResponse 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",
"callback_url": "https://platform.example.com/nowpay/purchase-return"
}'
# 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.purchase.consult' \
--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_purchase_consult_response。先完成验签并判断 code,再读取业务结果。
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|---|---|---|---|---|---|
decision | String | 必选 | 32 | 当前访问决策 | ALLOW:允许访问;PURCHASE_REQUIRED:需要购买;DENY:不允许访问且不引导购买 | ALLOW |
reason_code | String | 可选 | 128 | 业务结果原因码 | 结合 decision 或 consume_status 使用;不要按原因文案编写业务分支 | - |
valid_from | String | 特殊可选 | 128 | 表示本次有效权益的生效时间;格式 yyyy-MM-dd HH:mm:ss,时区 Asia/Shanghai | 仅 ONE_TIME_DURATION 且 decision=ALLOW 时返回;有效区间 [valid_from, valid_until) | 2026-09-07 10:00:00 |
valid_until | String | 特殊可选 | 128 | 表示本次有效权益的结束时间;格式 yyyy-MM-dd HH:mm:ss,时区 Asia/Shanghai | 仅 ONE_TIME_DURATION 且 decision=ALLOW 时返回;有效区间 [valid_from, valid_until) | 2026-10-07 10:00:00 |
product_name | String | 可选 | 128 | 商品名称 | - | 智能写作助手 |
product_icon_url | String | 可选 | 512 | 商品图标 | - | https://platform.example.com/assets/writing.png |
capability_status | String | 必选 | 128 | 商品收费能力状态 | NOT_CONFIGURED / CONFIGURING / PENDING / ACTION_REQUIRED / ENABLED / DISABLED / TERMINATED | ENABLED |
purchase_url | String | 特殊可选 | 512 | 购买链接 | PURCHASE_REQUIRED 返回 | alipays://platformapi/startapp?appId=2021006180624128&page=pages%2Forder%2Findex%3FpurchaseLinkId%3DSAMPLE_LINK_ID |
purchase_qr_code | String | 特殊可选 | 512 | 购买二维码 | PURCHASE_REQUIRED 返回 | https://mobilecodec.alipay.com/show.htm?code=SAMPLE_QR_CODE |
charging_options | ConsultChargingOption[] | 必选 | - | 当前商品的收费档位列表 | 可能为空数组;子字段必选性适用于实际返回的档位元素 | - |
charging_options[].sku_id | String | 必选 | 32 | 档位标识,平台原样回传 | 按不透明标识保存和回传,不解析内容 | S0806000200863004 |
charging_options[].plan_id | String | 必选 | 32 | 价格计划标识 | 按不透明标识保存和回传,不解析内容 | PI0806000200864211 |
charging_options[].display_name | String | 必选 | 32 | 档位名称 | - | 月度使用包 |
charging_options[].billing_mode | String | 必选 | 32 | 档位类型 | 本接口仅 ONE_TIME / ONE_TIME_DURATION | ONE_TIME_DURATION |
charging_options[].price | String | 必选 | 32 | 展示价格,十进制,单位元 | - | 9.90 |
charging_options[].currency | String | 必选 | 32 | 货币 | - | CNY |
charging_options[].price_version | Number | 必选 | 32 | 价格快照版本 | 整数;价格快照版本,仅展示和记录,不作为购买请求参数 | 1 |
charging_options[].entitlement_rule | String | 必选 | 32 | 权益类型 | 本接口仅 PERPETUAL / FIXED_DURATION | FIXED_DURATION |
charging_options[].duration_period | String | 特殊可选 | 32 | 时长包周期类型 | billing_mode=ONE_TIME_DURATION 时返回;WEEK / MONTH / QUARTER / YEAR | MONTH |
charging_options[].quota_unit | String | 特殊可选 | 32 | 额度类型 | 通用档位结构保留字段;仅额度包适用,本接口不返回 | - |
charging_options[].quota_amount | Number | 特殊可选 | 32 | 次数或积分数量,单位个 | 通用档位结构保留字段;仅额度包适用,本接口不返回 | - |
结果处理
| decision | 平台处理 |
|---|---|
ALLOW | 放行;时长包可展示 valid_from、valid_until |
PURCHASE_REQUIRED | 使用 purchase_url 或 purchase_qr_code 引导购买;返回后重新查询 |
DENY | 不放行、不新建购买入口;根据 reason_code 展示说明或稍后刷新 |
reason_code 是业务结果原因,不能代替 decision。常见拒绝原因包括权益暂不可用、商品已停用或需要创作者处理;遇到未识别的原因也不自动放行。
响应示例
以下为按单一业务场景整理的示例。签名、链接令牌和二维码均为占位值,不可直接使用。
{
"alipay_aipay_nowpay_purchase_consult_response": {
"code": "10000",
"msg": "Success",
"decision": "ALLOW",
"valid_from": "2026-09-07 10:00:00",
"valid_until": "2026-10-07 10:00:00",
"product_name": "智能写作助手",
"capability_status": "ENABLED",
"charging_options": [
{
"sku_id": "S0806000200863004",
"plan_id": "PI0806000200864211",
"display_name": "月度使用包",
"billing_mode": "ONE_TIME_DURATION",
"price": "9.90",
"currency": "CNY",
"price_version": 1,
"entitlement_rule": "FIXED_DURATION",
"duration_period": "MONTH"
}
]
},
"sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}{
"alipay_aipay_nowpay_purchase_consult_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}需要购买示例
{
"alipay_aipay_nowpay_purchase_consult_response": {
"code": "10000",
"msg": "Success",
"decision": "PURCHASE_REQUIRED",
"capability_status": "ENABLED",
"charging_options": [
{
"sku_id": "S0806000200863004",
"plan_id": "PI0806000200864211",
"display_name": "月度使用包",
"billing_mode": "ONE_TIME_DURATION",
"price": "9.90",
"currency": "CNY",
"price_version": 1,
"entitlement_rule": "FIXED_DURATION",
"duration_period": "MONTH"
}
],
"purchase_url": "alipays://platformapi/startapp?appId=2021006180624128&page=pages%2Forder%2Findex%3FpurchaseLinkId%3DSAMPLE_LINK_ID",
"purchase_qr_code": "https://mobilecodec.alipay.com/show.htm?code=SAMPLE_QR_CODE"
},
"sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}
公共错误码
参见支付宝公共错误码。网关或系统异常时,按原请求查询或重试;写操作不能在结果未确认时更换幂等号。
业务错误码
以下保留当前开放平台预览已列出的错误码,并补充平台处理建议。错误码列表可能扩展,平台应保留未知错误的待确认处理。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
SYSTEM_ERROR | 系统繁忙 | 稍后使用原参数重试;消费结果未知时先查询原请求 |
INVALID_PARAMETER | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
BILLING_MODE_NOT_SUPPORTED | 当前商品收费模式不适用于访问决策 | 仅买断和时长包使用本接口;额度包改用 quota.query |
NOW_PAY_BINDING_INVALID | 商品未绑定或未查到已上架商品 | 请核对商品是否已开通上架 |