alipay.marketing.voucher.query(券查询) 在线调试(沙箱环境)

商户券信息查询

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
voucher_id String 必选 28 券ID(券唯一标识, 发券接口返回参数) 20170616000730020041006ZYE2V

响应参数

参数 类型 是否必填 最大长度 描述 示例值
name String 必填 128 券名称(用户看到券名称) 商户代金券
voucher_id String 必填 28 券ID(同入参券ID) 20170616000730020041006ZYE2V
user_id String 必填 16 券所属用户ID 2088102146165572
template_id String 必填 32 券模板ID(模板唯一标识,创建模板返回) 0616844525285551005194106549
gmt_active Date 必填 32 券激活时间(券可以使用起始时间) 2015-04-02 13:32:43
gmt_expired Date 必填 32 券过期时间(券可以使用截止时间) 2015-04-02 13:32:43
total_amount Price 必填 13 券面额(元) 1.00
available_amount Price 必填 13 券余额(元) 1.00
status String 必填 32 券状态(ENABLED:可用,DISABLED:不可用,DELETE:删除状态,TRANS:发放中,TRANSFER:已转增,UNC:未领取,USED:已使用,USING:使用中,REFUNDED:已退款,REFUNDING:使用中,UNACTIVE:未激活,EXPIRED:已过期) ENABLED
gmt_create Date 必填 32 券创建时间(券发券时间) 2015-04-02 13:32:43
extend_info String 必填 4096 扩展信息,JSON格式 {}
bill_details VoucherBillDetail 选填 券交易账单信息(核销交易信息、交易退款信息等可能存在多条)
trade_no String 可选 64 支付宝交易号 2015040200073002576500000001
amount Price 必填 13 券核销/退款金额(元) 1.00
status String 必填 16 交易状态(I: 处理中, S: 成功) I
partner_id String 可选 32 交易合作伙伴ID 2088001159940003
partner_name String 可选 32 商户名称 商户名称
biz_type String 必填 32 账单类型(V_USE:支付,V_REFUND:退款) V_USE
gmt_create Date 必填 32 交易时间 2015-04-02 13:32:43

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingVoucherQueryRequest request = new AlipayMarketingVoucherQueryRequest();
request.setBizContent("{" +
"\"voucher_id\":\"20170616000730020041006ZYE2V\"" +
"  }");
AlipayMarketingVoucherQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_voucher_query_response": {
        "code": "10000",
        "msg": "Success",
        "name": "商户代金券",
        "voucher_id": "20170616000730020041006ZYE2V",
        "user_id": "2088102146165572",
        "template_id": "0616844525285551005194106549",
        "gmt_active": "2015-04-02 13:32:43",
        "gmt_expired": "2015-04-02 13:32:43",
        "total_amount": 1,
        "available_amount": 1,
        "status": "ENABLED",
        "gmt_create": "2015-04-02 13:32:43",
        "extend_info": "{}",
        "bill_details": [
            {
                "trade_no": "2015040200073002576500000001",
                "amount": 1,
                "status": "I",
                "partner_id": "2088001159940003",
                "partner_name": "商户名称",
                "biz_type": "V_USE",
                "gmt_create": "2015-04-02 13:32:43"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 REQUEST_PARAM_ILLEGAL
SYSTEM_ERROR 系统繁忙 数据库异常, 发起业务重试
SYSTEM_ERROR 系统繁忙 系统限流, 发起业务重试
SYSTEM_ERROR 系统繁忙 系统内部异常, 发起业务重试
SYSTEM_ERROR 系统繁忙 系统内部异常, 发起业务重试
INVALID_PARAMETER 参数有误 请检查券ID是否为28位, 券ID为发券接口返回唯一标识.
onlineServer