商户预授权

更新时间:2024.11.18

生成商户预授权投放会员卡的凭证

接口说明

支持商户:【普通服务商】

请求方式:【POST】/v3/marketing/membercard-open/cards/{card_id}/permission-tokens

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


path 路径参数

card_id  必填 string(32)

【会员卡模板ID】 商户创建微信会员卡模板成功后系统返回的会员卡模板ID


body 包体参数

activate_type  必填 string

【激活类型】 可指定该场景下的激活类型,支持一键自动激活及跳转激活两种类型。
AUTO_ACTIVATE:一键自动激活。用户点击开卡时,平台完成激活,并将用户授权的信息通过事件通知回调商家服务器;
JUMP_ACTIVATE:跳转激活。用户点击开卡时可跳转至商家h5/小程序,并将用户授权的信息及code加密传至商家h5/小程序,商家解密后可根据自由业务规则调用激活接口完成会员激活。


navigate_back_previous_page  选填 boolean

【设置用户在开卡完成后,是否返回拉起开卡组件的商家页面】 默认为false,若填写false,开卡完成后不返回商家页面,默认跳转到会员卡详情页面; 若填写true,则开卡完成后返回拉起开卡组件的商家页面。
注意:若该字段设置为true,且同时入参activate_url/activate_appid及activate_path,这种情况下,navigate_back_previous_page的设置不生效,系统将优先执行跳转。


activate_url  选填 string(128)

【跳转激活的URL】 激活类型是跳转激活时,用户点击开卡后跳转到商家网页的URL。如果同时配置了activate_url和activate_appid/path,则优先跳转到小程序


activate_appid  选填 string(32)

【跳转激活的AppID】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的AppID。如果同时配置了activate_url和activate_appid/path,则优先跳转到小程序


activate_path  选填 string(128)

【跳转激活的path】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的path


outer_str  选填 string(32)

【自定义场景值】 自定义场景值,商户可以用于标记投放场景,如门店/来源等。只能录入数字及中英文/半角标点

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/membercard-open/cards/pbLatjvWOibDc5-TBnbUk1pD12o0/permission-tokens \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "activate_type" : "AUTO_ACTIVATE",
8    "navigate_back_previous_page" : true,
9    "activate_url" : "https://w.url.cn/s/Ahz3p2C",
10    "activate_appid" : "wxea9c30a90fs8d3fe",
11    "activate_path" : "pages/activate/activate",
12    "outer_str" : "szwxtd"
13  }'
14

应答参数

200 OK

permission_token  必填 string(1024)

【预授权token】 用于H5场景拉起会员开卡组件投放会员卡

应答示例

200 OK

1{
2  "permission_token" : "EhhEF0Jt0uDLPK6Cr70KCrJmkTtfPPE222gUFsdP87CF4RqzpIdnNpDsbOD1kpsNuioecawJqEUfANcDhLrSA3xadU4pD6IJ7tpLEheA3kS1b6"
3}
4

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

403

NO_AUTH

商户暂无权限使用此功能

请开通商户号权限。请联系产品或商务申请

400

INVALID_REQUEST

扫码投放场景不支持实时code模式

请更换非实时code模式的会员卡再重试

400

INVALID_REQUEST

会员卡的创建商户号不等于调用方商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

请先升级会员卡才能使用此功能

请先调用《老会员卡模板升级API》升级会员卡

400

INVALID_REQUEST

会员卡ID无效

请检查会员卡ID是否正确填写

400

INVALID_REQUEST

该商户号不是会员卡的创建商户号

请使用会员卡的创建商户号进行操作

400

INVALID_REQUEST

需要上架至少一个积分权益、优惠权益

请先投放至少一个积分权益、优惠权益

400

INVALID_REQUEST

商户号不属于该卡的创建方

请使用会员卡创建方的商户号重新调用

400

PARAM_ERROR

激活类型是JUMP_ACTIVATE时,必须设置activate_url或activate_appid

请设置activate_url或activate_appid

 

 

反馈
咨询
目录
置顶