查询支付券详情
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.marketing.activity.voucher.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 | 必选 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
请求参数
参数中文名 | 参数英文名 | 类型 | 是否必选 | 长度/取值 | 描述 | 示例值 |
---|---|---|---|---|---|---|
活动 id | activity_id | String | 必选 | 长度范围:[1,128] | 活动id | 2016042700826004508401111111 |
商户接入模式 | merchant_access_mode | String | 必选 | 长度范围:[1,32] | 商户接入模式。枚举值商户自接入模式: SELF_MODE服务商代接入模式: AGENCY_MODE注意事项选择服务商代接入模式需配合 app_auth_token 代调用使用 | SELF_MODE |
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见文档 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数中文名 | 参数英文名 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|---|
活动基础信息 | activity_base_info | ActivityBaseInfo | 必选 | 活动基础信息 | ||
券发放详情 | voucher_send_mode_info | VoucherSendModeInfo | 必选 | 券发放详情 | ||
券优惠抵扣信息 | voucher_deduct_info | VoucherDeductInfo | 必选 | 券优惠抵扣信息 | ||
券可用范围 | voucher_available_scope_info | VoucherAvailableScopeInfo | 必选 | 券可用范围 | ||
券核销限制 | voucher_use_rule_info | VoucherUseRuleInfo | 必选 | 券核销限制 | ||
券展示信息 | voucher_display_pattern_info | VoucherDisplayPatternInfo | 必选 | 券展示信息 | ||
券引导信息 | voucher_customer_guide_info | VoucherCustomerGuideInfo | 必选 | 券引导信息 | ||
资金信息 | voucher_budget_supply_info | VoucherBudgetSupplyInfo | 必选 | 资金信息 | ||
券库存信息 | voucher_inventory_info | VoucherInventoryInfo | 必选 | 券库存信息 |
请求示例
响应示例
{
"alipay_marketing_activity_voucher_query_response": {
"code": "10000",
"msg": "Success",
"activity_base_info": {
"activity_id": "2016042700826004508401111111",
"activity_name": "满10减1活动",
"belong_merchant_info": {
"merchant_id_type": "SMID",
"merchant_id": "2088102111111111"
},
"activity_operation_status": "MODIFYING",
"activity_status": "ACTIVE"
},
"voucher_send_mode_info": {
"voucher_send_mode": "DIRECT_SEND_MODE",
"voucher_send_rule_info": {
"quantity": 100,
"max_quantity_by_day": 10,
"quantity_limit_per_user": 100,
"quantity_limit_per_user_period_type": "LIFE_CYCLE",
"natural_person_limit": false,
"phone_number_limit": false,
"real_name_limit": false,
"publish_start_time": "2017-01-01 00:00:01",
"publish_end_time": "2017-01-29 23:59:59"
}
},
"voucher_deduct_info": {
"voucher_type": "FIX_VOUCHER",
"fix_voucher_info": {
"amount": "50.00",
"floor_amount": "1000.00"
}
},
"voucher_available_scope_info": {
"voucher_available_account_info": {
"available_pids": [
"2088102111111111"
],
"available_smids": [
"2088102111111111"
]
},
"voucher_available_app_info": {
"available_app_ids": [
"2021238412323412"
]
},
"voucher_available_geography_scope_info": {
"available_geography_scope_type": "SHOP",
"available_geography_shop_info": {
"available_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
]
}
},
"voucher_available_goods_info": {
"goods_name": "美味甜甜圈",
"goods_description": "美味甜甜圈很美味",
"origin_amount": "100.00",
"available_goods_sku_ids": [
"apple-01",
"apple-02"
],
"exclude_goods_sku_ids": [
"'apple-03'",
"'apple-04'"
]
}
},
"voucher_use_rule_info": {
"quantity_limit_per_user": 1,
"quantity_limit_per_user_period_type": "DAY",
"voucher_use_time_info": {
"period_type": "ABSOLUTE",
"absolute_period_info": {
"valid_begin_time": "2017-01-10 00:00:00",
"valid_end_time": "2017-01-13 23:59:59"
},
"relative_period_info": {
"wait_days_after_receive": 1,
"valid_days_after_receive": 1
}
}
},
"voucher_display_pattern_info": {
"brand_name": "商家优惠",
"brand_logo_url": "https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ",
"voucher_name": "满10减1券",
"voucher_description": "1、本券不可兑换现金,不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款,优惠券无法退还。",
"voucher_image": "adeDSktiQO-u5vJUqVbcQwAAACMAAQED",
"voucher_image_url": "https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ",
"voucher_detail_images": [
"adeDSktiQO-u5vJUqVbcQwAAACMAAQE1",
"adeDSktiQO-u5vJUqVbcQwAAACMAAQE2",
"adeDSktiQO-u5vJUqVbcQwAAACMAAQE3"
],
"voucher_detail_image_urls": [
"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ"
],
"customer_service_mobile": "81XXXXXXX"
},
"voucher_customer_guide_info": {
"voucher_use_guide_info": {
"use_guide_mode": [
"MINI_APP"
],
"mini_app_use_guide_info": {
"mini_app_url": "alipays://platformapi/startapp?appId=xxxx"
}
}
},
"voucher_budget_supply_info": {
"budget_type": "NO_CASH",
"voucher_recharge_info": {
"recharge_type": "ALIPAY_BALANCE",
"voucher_balance_recharge_info": {
"logon_id": "username@gmail.com",
"amount": "50.00",
"partner_id": "2088512417841101"
}
}
},
"voucher_inventory_info": {
"send_count": 100,
"use_count": 1
}
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"alipay_marketing_activity_voucher_query_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
错误码
公共错误码
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 服务器异常 | 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
INVALID_PARAMETER | 参数有误参数非法 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试。 |