# 商品额度核销结果查询接口

## 接口说明

接口名称：`alipay.aipay.nowpaydirect.quota.refresh`

使用原消费请求号查询一笔额度核销的处理结果，用于核销超时、处理中或结果丢失后的恢复。此接口不刷新或增加余额，也不会发起新的额度扣减。

## 适用场景

- `quota.verify` 超时，无法确定是否已扣减。
- 核销返回 `PROCESSING`，需要继续查询最终状态。
- 恢复应用本地未确认的消费记录。

## 注意事项

- `out_request_no`、商品和受益人应与原 `quota.verify` 请求完全对应；无需重复传入 amount 或 `consume_reason`。
- 查询成功只表示获得了记录，仍需检查 `consume_status`。`SUCCEEDED` 完成本地消费确认，`FAILED` 按原因处理，`PROCESSING` 继续查询。
- 未找到记录时，不代表原请求一定未执行。核对原请求号并继续查询，或用完全相同的原请求重试 `quota.verify`，不能换新请求号重复扣减。
- remaining 表示原核销成功时的扣减后余额，后续购买或消费可能已改变余额；查询最新余额使用 `quota.query`。

## 公共请求参数

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

## 业务请求参数

| 参数 | 类型 | 是否必选 | 长度/取值 | 描述 | 注意事项/枚举值 | 示例值 |
| --- | --- | --- | --- | --- | --- | --- |
| `out_request_no` | String | 必选 | 128 | 商户生成的幂等请求号 | 重试保持原值与原业务参数；不同请求使用不同值 | `consume_20260927_000001` |
| `out_product_id` | String | 必选 | 128 | 直连商品的外部商品 `ID`，从管理小程序商品详情页复制 | 使用当前商户创建的商品；不要自行生成或使用内部商品号 | `np_d_f83a7c91` |
| `external_buyer_id` | String | 必选 | 128 | 应用内稳定的权益受益人标识 | 与应用登录用户绑定；不等同于付款账号 | `user_001` |

## 常见请求示例

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

::::aipay-tabs{defaultActiveKey="Java"}

:::aipay-tab{key="Java" title="Java"}
```java
import com.alipay.api.AlipayConfig;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.request.AlipayAipayNowpaydirectQuotaRefreshRequest;
import com.alipay.api.response.AlipayAipayNowpaydirectQuotaRefreshResponse;

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);

        AlipayAipayNowpaydirectQuotaRefreshRequest request = new AlipayAipayNowpaydirectQuotaRefreshRequest();
        request.setBizContent("{\"out_request_no\":\"consume_20260927_000001\",\"out_product_id\":\"np_d_f83a7c91\",\"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);
        }
        AlipayAipayNowpaydirectQuotaRefreshResponse response = client.execute(request);
        if (!response.isSuccess()) {
            // 按 code/sub_code 处理；结果未知时保留原业务请求号。
            System.out.println(response.getCode() + ":" + response.getSubCode());
            return;
        }
        // 网关成功后，按本页“结果处理”读取业务字段。
        System.out.println(response.getBody());
    }
}
```
:::

:::aipay-tab{key="cURL" title="cURL"}
```bash
biz_content='{
  "out_request_no": "consume_20260927_000001",
  "out_product_id": "np_d_f83a7c91",
  "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.nowpaydirect.quota.refresh' \
  --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_nowpaydirect_quota_refresh_response`。先完成验签并判断 `code`，再读取业务结果。

## 业务响应参数

| 参数 | 类型 | 是否必选 | 长度/取值 | 描述 | 注意事项/枚举值 | 示例值 |
| --- | --- | --- | --- | --- | --- | --- |
| `consume_status` | String | 必选 | 32 | 核销状态 | 成功:`SUCCEEDED`；失败:`FAILED`；进行中:`PROCESSING` | `SUCCEEDED` |
| `consume_reason` | String | 可选 | 512 | 消费原因 | 商户应持久化原始原因；查询结果可能不返回 | - |
| `quota_unit` | String | 必选 | 32 | 额度类型 | `COUNT`：次数；`POINT`：积分 | `COUNT` |
| `consumed` | Number | 特殊可选 | 99999999 | 本次实际扣减量，单位次数或积分 | `SUCCEEDED` 时使用；`PROCESSING` 时可能缺失，不补零、不推断扣减结果 | `1` |
| `remaining` | Number | 特殊可选 | 99999999 | 本次核销成功时，原子扣减后的可消费余额 | 仅 `SUCCEEDED` 时使用；不是当前实时余额 | `19` |
| `update_time` | String | 特殊可选 | 32 | 更新时间；格式 `yyyy-MM-dd HH:mm:ss`，时区 `Asia/Shanghai` | `SUCCEEDED` 时返回 | `2026-09-27 10:05:00` |

## 结果处理

处理规则与 [商品额度核销接口](alipay_aipay_nowpaydirect_quota_verify.md) 一致。仅在 `code=10000` 且 `consume_status=SUCCEEDED` 时确认原核销成功。未找到记录、超时、处理中及未知状态都进入应用待确认流程，保留原请求号。

## 响应示例

以下示例仅使用公开预览定义的字段，并按单一业务场景整理。签名、链接令牌和二维码均为占位值，不可直接使用。

::::aipay-tabs{defaultActiveKey="正常示例"}

:::aipay-tab{key="正常示例" title="正常示例"}
```json
{
  "alipay_aipay_nowpaydirect_quota_refresh_response": {
    "code": "10000",
    "msg": "Success",
    "consume_status": "SUCCEEDED",
    "quota_unit": "COUNT",
    "consumed": 1,
    "remaining": 19,
    "update_time": "2026-09-27 10:05:00"
  },
  "sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}
```
:::

:::aipay-tab{key="异常示例" title="异常示例"}
```json
{
  "alipay_aipay_nowpaydirect_quota_refresh_response": {
    "code": "20000",
    "msg": "Service Currently Unavailable",
    "sub_code": "isp.unknow-error",
    "sub_msg": "系统繁忙"
  },
  "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```
:::

::::

### 余额不足错误示例

```json
{
  "alipay_aipay_nowpaydirect_quota_refresh_response": {
    "code": "40004",
    "msg": "Business Failed",
    "sub_code": "NOW_PAY_QUOTA_INSUFFICIENT",
    "sub_msg": "额度不足"
  },
  "sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}
```

### 处理中示例

扣减量和余额可能缺失；保留原请求号继续查询，不把缺失值补为零后判定失败。

```json
{
  "alipay_aipay_nowpaydirect_quota_refresh_response": {
    "code": "10000",
    "msg": "Success",
    "consume_status": "PROCESSING",
    "quota_unit": "COUNT"
  },
  "sign": "RESPONSE_SIGNATURE_PLACEHOLDER"
}
```

## 公共错误码

参见[支付宝公共错误码](https://opendoc.alipay.com/common/02km9f)。网关或系统异常时，按原请求查询或重试；写操作不能在结果未确认时更换幂等号。

## 业务错误码

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

| 错误码 | 错误描述 | 解决方案 |
| --- | --- | --- |
| `SYSTEM_ERROR` | 系统繁忙 | 稍后使用原参数重试；消费结果未知时先查询原请求 |
| `INVALID_PARAMETER` | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试 |
| `BILLING_MODE_NOT_SUPPORTED` | 商品不是额度包模式 | 请核对入参参数相关的商品配置信息 |
| `CONSUME_REQUEST_NOT_FOUND` | 未找到匹配的幂等请求记录，请确认幂等号和请求状态 | 核对原请求号与商品；继续查询或原参数重试核销，不因未找到记录直接换号 |