接口描述
外部机构进行营销活动资格发放抽奖
请求方式
POST
生产调用地址
https://openapi.unionpay.com/upapi/mkt/aim/aimMaktgDraw/v1
测试调用地址
https://openapi.unionpay.com/upapi/mkt/aim/aimMaktgDraw/v1
HTTP报文体参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 命令字 | cmd | string | 32 | M-必填 | maktgDraw
|
||
| 系统Id | chnlId | string | an4 | M-必填 |
|
||
| 请求跟踪号 | traceId | string | n..64 | C-按条件必填 | 由最上层的调用方生成，在整个调用链的上下游系统传递，可通过traceId关联各系统的流水。
|
||
| Qid | qid | string | an..64 | M-必填 | 唯一标识的流水号
|
||
| 请求日期 | transDt | string | 8 | M-必填 | 格式yyyyMMdd
|
||
| 来源类型 | srcType | string | 2 | M-必填 | 02：行为
|
||
| 营销场景 | maktgScene | string | 2 | M-必填 | 14：外部侧抽奖
|
||
| 用户Id | userId | string | an1..64 | C-按条件必填 |
|
||
| 卡号 | cardNo | string | 1..128 | C-按条件必填 | 报文传输采用SM4算法加密
该参数已配置加密规则：SM4 查看详情 |
||
| 手机号 | mobile | string | 1..32 | C-按条件必填 | 报文传输采用SM4算法加密
该参数已配置加密规则：SM4 查看详情 |
||
| 设备终端 | icTmn | string | ans1..256 | C-按条件必填 |
|
||
| 证件号 | certId | string | ans1..128 | C-按条件必填 | SM3加密，建议使用公司采购的国密软件包XD_VHSM 进行加密
|
||
| 活动编号 | activityNo | string | n15..16 | M-必填 |
|
||
| 红包码 | qrCode | string | an..200 | 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.aim.aimMaktgDraw.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位表示错误原因；
取值详见附录1。
|
||
| 应答码描述 | msg | string | 128 | M-必填 | 同一个应答码可对应多个不同的描述，对处理结果进行详细提示
|
||
| 详细应答码 | subCode | string | 10 | C-按条件必填 | 当应答码非成功时出现，并且描述了详细的业务处理失败的原因。
当由银联系统直接产生应答码时，宜在详细应答码中体现系统简称（如前3位为SWT）。
|
||
| 详细应答码描述 | subMsg | string | 128 | C-按条件必填 | 同一个详细错误码可对应多个不同的描述，对处理结果进行详细提示。
包含多个错误信息，供进一步分析错误原因使用。
|
||
| 系统Id | chnlId | string | 4 | C-按条件必填 | 调用方系统Id
|
||
| Qid | qid | string | 64 | C-按条件必填 | 唯一标识的流水号
|
||
| 结果时间 | respTs | string | 14 | C-按条件必填 | 格式为：yyyyMMddHHmmss
|
||
| 奖项信息 | awardInfo | string | 1..256 | C-按条件必填 |
|
示例代码
l 成功应答报文结果：
{
"code" : "0000000000",
"msg": "交易成功",
"chnlId": "70000",
"qid": "201912251528154943067",
"respTs": "20191225152815",
"awardInfo": {
"activityNo": "1320191225015401",
"activityNm": "新优惠券-wq",
"beginTs": "20191225000000",
"endTs": "20201231235959",
"awardId": "2120191225015405",
"awardTp": "08",
"awardNm": "新优惠券6等奖",
"awardValue": "1",
"awardLevel": "1",
"extAcctId": "3112019122500960",
"extAcctName": "满2件立减1.00元",
"drawDesc": "满2件立减1.00元",
"couponValidBeginTs": "",
"couponValidEndTs": "",
"couponGoodsUrl": "http://vop.95516.net:8080/#/m2vop/Y00701?tmpId=MB20191107000248&tmpType=1",
"redirectUrlType": "rn",
"redirectUrl": ""
}
l 异常应答报文结果：
{
"code":"UP40040000",
"msg":"请求业务失败",
"subCode":"AM03051",
"subMsg":"xxx",
"chnlId": null,
"qid": null,
"respTs": null,
"awardInfo": null
}
中国银联版权所有© 沪ICP备07032180号-2 沪公网安备31011502002335号
