查询用户券详情
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://openapi.alipay.com/v3/alipay/marketing/activity/ordervoucher/user/voucher
错误码
公共错误码
业务错误码
| 状态码 | 错误码 | 错误描述 | 解决方案 |
|---|---|---|---|
| 400 | SYSTEM_ERROR | 服务器异常 | 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| 400 | INVALID_PARAMETER | 参数有误参数有误参数有误参数有误参数非法 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。 |
| 400 | ACTIVITY_NOT_PERMISSION | 当前商户没有该活动的权限 | 当前商户没有该活动的权限。请检查参数是否传入错误。 |
| 400 | MERCHANT_RELATION_NOT_EXIST | 商户关系校验失败。 | 当前请求的商户与传入的merchant_id没有有效的关联关系。 |
| 400 | VOUCHER_NOT_EXIST | 券不存在 | 传入的券不存在或券码未发放给用户。请检查是否传入错误。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi.alipay.com/v3/alipay/marketing/activity/ordervoucher/user/voucher?merchant_id=&user_id&activity_id&voucher_id=&voucher_code=&merchant_access_mode'响应示例响应示例
{
"user_voucher_base_info": {
"voucher_id": "string",
"voucher_name": "string",
"voucher_status": "string",
"create_time": "string",
"valid_begin_time": "string",
"valid_end_time": "string",
"associate_trade_no": "string",
"voucher_max_use_times": 0,
"voucher_used_times": 0
},
"activity_base_info": {
"activity_id": "string",
"belong_merchant_info": {
"merchant_id": "string"
},
"activity_status": "string"
},
"voucher_send_mode_info": {
"voucher_send_mode": "string",
"voucher_sale_mode_info": {
"sale_amount": "string",
"refundable": true,
"overdue_refundable": true
},
"voucher_package_mode_info": {
"voucher_package_id": "string"
},
"voucher_send_rule_info": {
"quantity": 0,
"max_quantity_by_day": 0,
"quantity_limit_per_user": 0,
"quantity_limit_per_user_period_type": "string",
"natural_person_limit": true,
"phone_number_limit": true,
"real_name_limit": true,
"publish_start_time": "string",
"publish_end_time": "string"
}
},
"voucher_use_rule_info": {
"quantity_limit_per_user": 0,
"quantity_limit_per_user_period_type": "string",
"voucher_max_use_times": 0,
"voucher_use_time_info": {
"period_type": "string",
"absolute_period_info": {
"valid_begin_time": "string",
"valid_end_time": "string",
"time_restrict_info": {
"usable_period_info": [
{
"rule_type": "string",
"week_rule_info": {
"week_day": "string",
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
}
}
],
"disable_period_info": [
{
"rule_type": "string",
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
},
"holiday_rule_info": {
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
}
}
]
}
},
"relative_period_info": {
"wait_days_after_receive": 0,
"valid_days_after_receive": 0,
"time_restrict_info": {
"usable_period_info": [
{
"rule_type": "string",
"week_rule_info": {
"week_day": "string",
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
}
}
],
"disable_period_info": [
{
"rule_type": "string",
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
},
"holiday_rule_info": {
"time_range_info": {
"begin_time": "string",
"end_time_info": {
"end_time_type": "string",
"end_time": "string"
}
}
}
}
]
}
}
}
},
"voucher_deduct_info": {
"voucher_type": "string",
"fix_voucher_info": {
"amount": "string",
"floor_amount": "string"
},
"discount_voucher_info": {
"discount": "string",
"ceiling_amount": "string",
"floor_amount": "string"
},
"special_voucher_info": {
"special_amount": "string",
"floor_amount": "string"
},
"exchange_voucher_info": {
"amount": "string",
"floor_amount": "string",
"biz_type": "string"
}
},
"voucher_display_pattern_info": {
"brand_name": "string",
"brand_logo_url": "string",
"voucher_description": "string",
"voucher_image_url": "string",
"voucher_detail_image_urls": [
"string"
],
"customer_service_mobile": "string",
"customer_service_url": "string"
}
}请求参数
Query 参数
merchant_id
string
可选
注意事项
1、商户自运营时，可不填写 2、服务商在P站代运营建券时，请填入代运营商户的PID。 代运营授权流程可查看：https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83
user_id
string
支付宝用户 id
activity_id
string
可选
注意事项
当传入 voucher_code 时该值必传。
必选条件
voucher_id
string
可选
voucher_code
string
可选
merchant_access_mode
string
可选
枚举值
商户自接入模式: SELF_MODE
服务商代接入模式: AGENCY_MODE
注意事项
选择服务商代接入模式需配合 app_auth_token 代调用使用