增加用户记录API

最新更新时间:2020.06.04 版本说明


当用户在商户侧消费时,用户完成了微信先享卡的目标或者获取使用优惠时,商户需要把这个信息同步给微信先享卡平台,用于在微信先享卡小程序展示及先享卡到期后的用户结算。

接口说明

适用对象:直连商户

请求URL:https://api.mch.weixin.qq.com/v3/discount-card/cards/{out_card_code}/add-user-records

请求方式:POST

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
商户领卡号 out_card_code string[1,32] path 商户在请求领卡预受理接口时传入的领卡请求号,同一个商户号下必须唯一,要求32个字符内,只能是数字、大小写字母_-|*
示例值:6e8369071cd942c0476613f9d1ce9ca3
先享卡模板ID card_template_id string[1,64] body 先享卡卡模板ID,唯一定义此资源的标识。创建模板后可获得。
示例值:87789b2f25177433bcbf407e8e471f95
+ 目标完成记录 objective_completion_records array body 用户完成的目标明细列表。
特殊规则:限制仅提交1条
参数名 变量 类型[长度限制] 必填 描述
目标完成流水号 objective_completion_serial_no string[1,32] 目标流水号,由商户侧生成,由数字、字母组成,由商户侧保证商户系统内全局唯一性,用于做目标同步时的幂等判断。
示例值:578354545
目标ID objective_id string[1,32] 微信先享卡为每个先享卡目标分配的唯一ID。
示例值:123456
目标完成时间 completion_time string[1,32] 用户履约行为发生的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
目标完成类型 completion_type string[1,8] 目标完成类型,枚举值: 
INCREASE:增加数量,表示用户发生了履约行为
DECREASE:减少数量,表示取消用户的履约行为(例如用户取消购买、退货退款等)
示例值:INCREASE
目标完成描述 description string[1,20] 用户本次履约的描述。
示例值:购买商品
目标完成数量 completion_count int 用户本次履约的数量,必须大于0。
示例值:1
备注说明 remark string[1,50] 对于用户履约情况的一些补充信息。
示例值:特价商品
+ 优惠使用记录 reward_usage_records array body 优惠使用记录列表。
特殊规则:限制仅提交1条
参数名 变量 类型[长度限制] 必填 描述
优惠使用记录流水号 reward_usage_serial_no string[1,32] 商户侧生成,由数字、字母组成,由商户侧保证商户系统内全局唯一性,用于做奖励同步时的幂等判断。
示例值:578354
优惠ID reward_id string[1,32] 微信先享卡为每个先享卡优惠分配的唯一ID
示例值:123456
优惠使用时间 usage_time string[1,32) 用户使用优惠的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
优惠使用类型 usage_type string[1,8] 目标完成类型,枚举值: 
INCREASE:增加数量,表示用户发生了履约行为
DECREASE:减少数量,表示取消用户的履约行为(例如用户取消购买、退货退款等)
示例值:INCREASE
优惠使用描述 description string[1,20] 用户获得奖励的描述
示例值:购买商品
数量 usage_count int 用户本次获得的奖励数量,必须大于0。
示例值:1
金额 amount int64 1、优惠金额,用户此项本次享受的优惠对应的优惠总金额,单位:分,必须大于0。
2、子优惠已享金额累计≤创建模板时配置的此子优惠的价值金额 例如:优惠为【满10元减3元优惠券4张】时,用户一次消费使用了2张优惠券,优惠金额为本次优惠总金额6元,优惠数量为本次使用优惠的优惠券数量2张
示例值:100
备注说明 remark string[1,50] 对于用户奖励情况的一些补充信息
示例值:特价商品

请求示例


{
  "card_template_id" : "87789b2f25177433bcbf407e8e471f95",
  "reward_usage_records" : [ {
    "usage_count" : 100,
    "amount" : 1,
    "usage_type" : "INCREASE",
    "usage_time" : "2015-05-20T13:29:35.120+08:00",
    "reward_usage_serial_no" : "578354",
    "description" : "购买商品",
    "reward_id" : "123456",
    "remark" : "特价商品"
  }, ],
  "objective_completion_records" : [ {
    "completion_time" : "2015-05-20T13:29:35.120+08:00",
    "objective_completion_serial_no" : "578354545",
    "description" : "购买商品/取消购买商品",
    "completion_count" : 1,
    "remark" : "特价商品",
    "completion_type" : "INCREASE",
    "objective_id" : "123456"
  }, {
    "completion_time" : "2015-05-20T13:29:35.120+08:00",
    "objective_completion_serial_no" : "578354545",
    "description" : "购买商品/取消购买商品",
    "completion_count" : 1,
    "remark" : "特价商品",
    "completion_type" : "INCREASE",
    "objective_id" : "123456"
  } ]
}

    
{
JAVA示例代码
}
    

返回参数

204
处理成功,应答无内容


返回示例


无数据返回
                                

    http://2323weixin.qq.com
                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 5开头的状态码都为系统问题,请使用相同参数稍后重新调用
400 PARAM_ERROR 参数错误 根据错误提示,传入正确参数
404 RESOURCE_NOT_EXISTS 订单不存在,请检查订单号是否正确 请传入正确的订单号
400 INVALID_REQUEST 请求参数符合参数格式,但不符合业务规则 当前状态无需操作
401 SIGN_ERROR 签名验证失败 请检查签名参数和方法是否都符合签名算法要求
403 NO_AUTH 权限异常 请开通商户号相关权限,请联系产品或商务申请
429 FREQUENCY_LIMITED 请求超过频率限制 请求未受理,请降低频率后重试

版本说明

关闭
V1.0
2020.03.26
1. 更新先享卡订单接口上线

技术咨询

反馈有奖