接口描述
优惠券状态变动后调外部接口地址进行通知。
请求方式
POST
生产调用地址
测试调用地址
HTTP报文体参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|
| 系统ID | chnlId | string | an..6 | M-必填 | 目前为银联内部系统ID，后续会调整为渠道方代码
|
||
| 请求跟踪号 | traceId | string | an..64 | M-必填 | 银联营销平台用于上下文串联
|
||
| 交易时间 | transDtTm | string | n14 | M-必填 | YYYYMMDDHHMMSS
|
||
| 优惠券ID | couponId | string | an..64 | M-必填 | 票券活动ID，由银联营销平台生成，31打头的16位数字 ；同赠送优惠券接口中的discountId。
|
||
| 活动名称 | couponNm | string | an..64 | M-必填 | 票券活动名称，由业务人员通过银联营销平台录入，同赠送优惠券接口中的discountId。
|
||
| 变动数量 | couponNum | long | n..12 | M-必填 | 指票券变动的数量，当operTp为04时，对应票券发放数量；当operTp为01时，对应票券使用数量
|
||
| 操作类型 | operTp | string | a4 | M-必填 | 01：优惠券承兑；02：优惠券返还；03：优惠券无操作；04：优惠券获取；05：优惠券删除；06：优惠券过期
|
||
| 券码 | couponCd | string | an..256 | M-必填 | 同一优惠活动的下某一优惠券的唯一标识，包括内部券外部券码；每笔赠送优惠券请求对应一个券码；建议优惠券ID和券码组合判断唯一一张券。
|
||
| 交易类型 | transTp | string | a2 | C-按条件必填 | 仅在operTp为01、02、03时出现，取值为01消费，31撤销，04退货
|
||
| 订单金额 | orderAt | long | a..12 | M-必填 | 在transTp为01时值有效，代表核销票券交易的订单金额；在transTp为31时，代表撤销交易的订单金额；在transTp为04时，代表应退优惠金额。其他时候，一般默认为0，不具有特定含义。
|
||
| 优惠金额 | discountAt | long | a..12 | M-必填 | 在transTp为01时值有效，代表该笔交易中票券抵扣金额；在transTp为31时，代表撤销交易的撤回的票券优惠金额；在transTp为04时，代表应退优惠金额。其他时候，一般默认为0，不具有特定含义。
|
||
| 交易渠道 | transChnl | string | a4 | C-按条件必填 | 仅在transTp为01、31、04时出现；0001-线上支付；0002-二维码支付；0003-线下POS
|
||
| 商户编号 | mchntCd | string | an..24 | C-按条件必填 |
|
||
| Pos终端号 | posTmn | string | an..256 | C-按条件必填 |
|
||
| 券码信息列表 | couponCdInfos | list | C-按条件必填 | couponCdInfo数组，内容字段见下面的表格
|
HTTP消息头参数
| 中文名称 | 英文名称 | 域类型 | 域长度 | 默认值 | 样例值 | 请求要求 | 备注 | |
|---|---|---|---|---|---|---|---|---|
| 字符集 | charset | string | 16 | M-必填 | 固定值：UTF-8
|
|||
| 请求唯一标识 | reqId | string | 64 | M-必填 | 由服务方系统生成，保证每笔请求不重复，但非交易主键。
|
|||
| 请求格式 | contentType | string | 128 | M-必填 | 固定为：application/json
|
|||
| 版本号 | version | string | 8 | M-必填 | 表示系统处理层级的报文版本编号。 格式：xx.yy.zz 取值举例：1.0.0
|
|||
| 发送方索引类型 | appType | string | 2 | M-必填 | 发送方索引类型与发送方索引标识码唯一标识一个签名索引。取值：00：银联索引
|
|||
| 业务类型 | bizMethod | string | 64 | M-必填 | 由根据服务提供方业务类型编号和接口代码生成（固定值：mkt.CpnStateUpdtNotify）。
|
|||
| 交易类型 | apiId | string | 64 | M-必填 | 即接口代码
|
|||
| 服务使用方编号 | appId | string | 5..32 | M-必填 | 即网关用户
|
|||
| 签名或摘要方式 | signMethod | string | 20 | M-必填 | 即SHA256WithRSA
|
|||
| 时间戳 | reqTs | string | 13 | M-必填 | 时间戳是指从纪元时间（1970年1月1日00时00分00秒）开始计算的毫秒数。
|
|||
| 签名 | sign | string | 344 | M-必填 |
|
示例代码
l 请求报文头参数
{
charset=UTF-8,
bizMethod=mkt.CpnStateUpdtNotify,
appType=00,
appId=up_49mm93f1k15qj_u13, sign=ec34BJVrzGmhGR8kJ8q/Um3uD5/cOPTt0LEsGxLDTZeFkpCLmJ7HYz873nJjJcazCHMESxBZ6fNe1IDjzRP+h4jDf3IUmuAM7Dktfh5RXvVby2bO/aADUzKLf0JtGS7ZBFroCg+YWTA+JPm+RUPJNoNvCkMf8uzafV3e5gw/3usGTtAULbLEu2LNhK5MC2rhJbDahkBgZlvz1hKmfToWxuciXHFzAjrtpSrQYW1viQ/CXlEzp83yQdtJ2iQSyRJkLzwjHUSY+eQ2wyLfSLZrsj2YtEnNewORVRKc7YHouflaprrORsrrBXjB/9cEW0sdkuYQM3LMKRsr4SmqHB03ig==, reqTs=1661931538000,
version=1.0.0,
contentType=application/json,
apiId=CpnStateUpdtNotify,
signMethod=RSA2,
reqId=100_202208311538580386732}
l 请求报文参数
{
"chnlId":"9001",
"couponId":"3102022082600369",
"couponNm":"银联1元立减金",
"couponNum":1,
"operTp":"01",
"couponCd":"INNER_22083115122703367252829676378085",
"transTp":"01",
"orderAt":1800,
"discountAt":100,
"transChnl":"0002",
"transDtTm":"20220831153858",
"transSeq":"202208311538580386732",
"traceId":"44220831563174520771",
"mchntCd":"105001858120243",
"posTmn":"00158795",
"couponCdInfos":[{"couponCd":"INNER_23050811072201808962851604619622","subAcctOperAt":1}]}
中国银联版权所有© 沪ICP备07032180号-2 沪公网安备31011502002335号
