同步积分兑券结果
更新时间:2025.08.20当用户触发积分兑券后,微信支付将通过用户积分兑券事件通知接口回调给商家。商家需要把是否允许积分兑券同步给微信支付侧,微信支付侧将根据该同步结果判断是否发券。
注意:如果返回的积分兑券状态为积分兑券失败,商家需要回滚积分。
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/card-member/user-points/exchange-coupon/confirm
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
接口限频:100/秒(品牌ID维度)
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
body 包体参数
record_id 必填 string(64)
【积分兑券ID】 用户积分兑券的记录ID,可从用户积分兑券事件通知中获取。
exchange_coupon_template_id 必填 string(32)
【积分兑券模板ID】 积分兑券模板ID,由微信支付生成(灰度期间联系微信支付运营获取)。
card_id 必填 string(32)
【会员卡模板ID】 商家创建会员卡模板成功后系统返回的会员卡模板ID
openid 必填 string(128)
【用户标识】 用户在品牌商家会员卡模板AppID下的唯一标识,获取方式详见参数说明。
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模板下的唯一标识,用户领取会员卡后获得的code。只能填写数字/英文/半角标点。平台支持2种会员卡code分配类型:(1)SYSTEM_ALLOCATE 微信支付系统分配,用户领取会员卡时从微信系统分配24位数字作为会员code;(2)MERCHANT_ALLOCATE 商家分配,商家同步会员开通结果时传入,用户开卡成功或失败都以商家传入的code作为会员卡code。
result 必填 string
【积分兑券结果】 积分兑券结果
可选取值
POINT_EXCHANGE_COUPON_ALLOW: 允许积分兑券POINT_EXCHANGE_COUPON_REJECT: 拒绝积分兑券
reject_reason 选填 string(32)
【拒绝兑券原因】 拒绝兑券原因,当积分兑券结果为拒绝时必填
请求示例
POST
应答参数
200 OK
record_id 必填 string(64)
【积分兑券ID】 用户积分兑券的记录ID,可从用户积分兑券事件通知中获取。
exchange_coupon_template_id 必填 string(32)
【积分兑券模板ID】 积分兑券模板ID,由微信支付生成(灰度期间联系微信支付运营获取)。
brand_id 必填 string(16)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID(灰度期间联系微信支付运营获取),用于标记该会员卡的归属方
card_id 必填 string(32)
【会员卡模板ID】 商家创建会员卡模板成功后系统返回的会员卡模板ID
openid 必填 string(128)
【用户标识】 用户在品牌商家会员卡模板AppID下的唯一标识,获取方式详见参数说明。
user_card_code 必填 string(32)
【会员卡code】 会员在一个会员卡模板下的唯一标识,用户领取会员卡后获得的code。只能填写数字/英文/半角标点。平台支持2种会员卡code分配类型:(1)SYSTEM_ALLOCATE 微信支付系统分配,用户领取会员卡时从微信系统分配24位数字作为会员code;(2)MERCHANT_ALLOCATE 商家分配,商家同步会员开通结果时传入,用户开卡成功或失败都以商家传入的code作为会员卡code。
state 必填 string
【积分兑券状态】 积分兑券状态
可选取值
POINT_EXCHANGE_COUPON_SUCCESS: 积分兑券成功POINT_EXCHANGE_COUPON_FAIL: 积分兑券失败
product_coupon_id 必填 string
【商品券ID】 积分兑券模板配置的商品券ID。
product_coupon_stock_type 必填 string
【商品券批次类型】 用于区分商品券的批次类型。
可选取值
PRODUCT_COUPON_STOCK_TYPE_BUSI_FAVOR: 基于商家券创建的商品券PRODUCT_COUPON_STOCK_TYPE_CASH_FAVOR: 基于代金券创建的商品券PRODUCT_COUPON_STOCK_TYPE_BRAND_FAVOR: 商品券2.0
stock_id 必填 string
【批次ID】 积分兑券模板配置的商品券批次ID。
coupon_code 选填 string(128)
【兑券成功的券code】 商品券的唯一标识,当积分兑券状态为成功时必填
reject_reason 选填 string(32)
【拒绝兑券原因】 拒绝兑券原因,当积分兑券结果为拒绝时必填
应答示例
200 OK
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | PARAM_ERROR | 请求参数和积分兑券记录参数不一致 | 请检查用户积分兑券事件通知的参数和请求的参数是否一致 |
400 | PARAM_ERROR | Http header中缺少必填参数Wechatpay-Serial | 缺少必要商品券图片,请补充上传后重试 |
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
429 | RATELIMIT_EXCEEDED | 接口请求频率达到限制 | 请降低请求接口频率 |
400 | PARAM_ERROR | 请求中含有未在API文档中定义的参数 | 请求中含有未在API文档中定义的参数,请检查传递的参数列表是否有编写错误的字段名 |
