接口描述
用以删除指定优惠券ID以及主体标识等信息的优惠券，此接口会删除指定数量的此种优惠券并归还优惠券的张数封顶（个人封顶不归还）
请求方式
POST
生产调用地址
https://openapi.unionpay.com/upapi/mkt/cpn/couponDelete/v1
测试调用地址
https://openapi.unionpay.com/upapi/mkt/cpn/couponDelete/v1
HTTP报文体参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 渠道方代码 | chnlId | string | an4 | M-必填 | 区分业务权限，进行数据权限控制
|
||
| CMD | cmd | string | 20 | M-必填 | 固定：couponDelete
|
||
| 接入方ID | accessId | string | an2 | M-必填 | 固定填写UP
|
||
| Qid | qid | string | an1..64 | M-必填 |
|
||
| 外部活动ID | outerActivityNo | string | an1..64 | C-按条件必填 |
|
||
| 请求日期 | orderDt | string | 8 | M-必填 | （yyyyMMdd）
|
||
| 请求跟踪号 | traceId | string | an1..64 | M-必填 |
|
||
| 优惠券ID | discountId | string | an1..64 | M-必填 |
|
||
| 下载数量 | discountNum | long | M-必填 |
|
|||
| 优惠券主体类型 | entityTp | string | 2 | M-必填 | 01:手机号维度；02:卡号维度；03:用户ID维度；05:外部用户ID维度；06：网络支付平台用户ID;07：证件号维度
|
||
| 优惠券主体标识卡号 | cardNo | string | an1..64 | C-按条件必填 | entityTp为02则必填
|
||
| 优惠券主体标识手机号 | mobile | string | an1..64 | C-按条件必填 | entityTp为01则必填
|
||
| 优惠券主体标识银联用户 | openId | string | an1..256 | C-按条件必填 | entityTp为03则必填
|
||
| 外部AppId | extAppId | string | n1..64 | C-按条件必填 | entityTp为05、06时必填.赠送的票券如果在二维码渠道核销，则该值为二维码分配的appid
|
||
| 优惠券主体标识外部用户 | extUserId | string | n1..64 | C-按条件必填 | entityTp为05则必填
|
||
| 优惠券主体标识网络支付平台用户ID | huserId | string | n1..64 | C-按条件必填 | entityTp为06则必填
|
||
| 证件号 | certId | string | an..128 | C-按条件必填 | entityTp为07则必填。SM3，16进制编码，小写
|
||
| 券码 | couponCd | string | an1..256 | C-按条件必填 | 内部券、外部券及内外部联合核销券可填
|
||
| logId | logId | string | an1..128 | C-按条件必填 |
|
HTTP消息头参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 样例值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|---|
| 版本号 | version | string | 8 | M-必填 | 取值：1.0.0
|
|||
| 发送方索引类型 | appType | string | 2 | M-必填 | 取值：
00：银联索引
01 机构索引
02 商户索引
|
|||
| 发送方索引标识码 | appId | string | 32 | M-必填 | appId由开放平台网关分配，取值开放平台网关API认证账号
|
|||
| 接口类型 | bizMethod | string | 64 | M-必填 | 取值：mkt.cpn.couponDelete_v1
|
|||
| 签名 | sign | string | 344 | M-必填 | 对报文摘要的签名
|
|||
| 签名方式 | signMethod | string | 20 | M-必填 | 取值：
RSA2：先使用SHA-256计算摘要，再使用RSA完成签名，样例代码参考https://open.unionpay.com/tjweb/support/doc/online/3/801
SM2：先使用SM3计算摘要，再使用SM2完成签名，样例代码参考
https://open.unionpay.com/tjweb/support/doc/online/3/811
|
|||
| 发送方流水号 | reqId | string | 64 | M-必填 | 由发送方自动生成
|
|||
| 时间戳 | reqTs | string | 32 | M-必填 | 当前时间戳
|
同步应答参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 应答码 | code | string | 10 | M-必填 | 成功应答码为’0000000000’
失败应答码格式：
第1-2位表示应答码生成方；
第3-10位表示错误原因；
取值详见应答码菜单。
|
||
| 应答码描述 | msg | string | 128 | M-必填 | 同一个应答码可对应多个不同的描述，对处理结果进行详细提示
|
||
| 详细应答码 | subCode | string | 10 | C-按条件必填 | 当应答码非成功时出现，并且描述了详细的业务处理失败的原因。
当由银联系统直接产生应答码时，宜在详细应答码中体现系统简称（如前3位为SWT）。
|
||
| 详细应答码描述 | subMsg | string | 128 | C-按条件必填 | 同一个详细错误码可对应多个不同的描述，对处理结果进行详细提示。
包含多个错误信息，供进一步分析错误原因使用。
|
||
| 优惠券ID | discountId | string | 1..64 | M-必填 |
|
||
| Qid | qid | string | 64 | C-按条件必填 | 原请求流水号
|
||
| 券码 | couponCd | string | 1..256 | C-按条件必填 |
|
示例代码
l 请求报文头参数
{
"chnlId": "1310",
"accessId": "UP",
"cmd": "couponDelete",
"qid": "2019122712341234",
"outerActivityNo": "10000789",
"orderDt": "20191227",
"traceId": "trace2019122712341234",
"discountId": "3112019122000939",
"discountNum": "0",
"entityTp": " 01",
"entityId": "13022982789",
"logId": "log2019122712341234"
}
中国银联版权所有© 沪ICP备07032180号-2 沪公网安备31011502002335号
