商户预授权
更新时间:2023.11.28生成商户预授权投放会员卡的凭证
# 接口说明
支持商户: 【普通商户】
请求方式: 【POST】
请求URL: /v3/marketing/membercard-open/cards/{card_id}/permission-tokens
# 请求参数
- card_id 必填【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡模板ID
Path 路径参数
- activate_type 必填【激活类型】 可指定该场景下的激活类型,支持一键自动激活及跳转激活两种类型。AUTO_ACTIVATE:一键自动激活。用户点击开卡时,平台完成激活,并将用户授权的信息通过事件通知回调商家服务器;JUMP_ACTIVATE:跳转激活。用户点击开卡时可跳转至商家h5/小程序,并将用户授权的信息及code加密传至商家h5/小程序,商家解密后可根据自由业务规则调用激活接口完成会员激活。
- navigate_back_previous_page 选填【设置用户在开卡完成后,是否返回拉起开卡组件的商家页面】 默认为false,若填写false,开卡完成后不返回商家页面,默认跳转到会员卡详情页面; 若填写true,则开卡完成后返回拉起开卡组件的商家页面。 注意:若该字段设置为true,且同时入参activate_url/activate_appid及activate_path,这种情况下,navigate_back_previous_page的设置不生效,系统将优先执行跳转。
- activate_url 选填【跳转激活的URL】 激活类型是跳转激活时,用户点击开卡后跳转到商家网页的URL。如果同时配置了activate_url和activate_appid/path,则优先跳转到小程序
- activate_appid 选填【跳转激活的AppID】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的AppID。如果同时配置了activate_url和activate_appid/path,则优先跳转到小程序
- activate_path 选填【跳转激活的path】 激活类型是跳转激活时,用户点击开卡后跳转到商家小程序的path。
- outer_str 选填【自定义场景值】 自定义场景值,商户可以用于标记投放场景,如门店/来源等。只能录入数字及中英文/半角标点
Body 包体参数
# 返回参数
- permission_token 必填【预授权token】 用于H5场景拉起会员开卡组件投放会员卡
请求示例
1{2 "activate_type": "AUTO_ACTIVATE",3 "navigate_back_previous_page": true,4 "activate_url": "https://w.url.cn/s/Ahz3p2C",5 "activate_appid": "wxea9c30a90fs8d3fe",6 "activate_path": "pages/activate/activate",7 "outer_str": "szwxtd"8}
返回示例
1{2 "permission_token": "EhhEF0Jt0uDLPK6Cr70KCrJmkTtfPPE222gUFsdP87CF4RqzpIdnNpDsbOD1kpsNuioecawJqEUfANcDhLrSA3xadU4pD6IJ7tpLEheA3kS1b6"3}
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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 |
文档是否有帮助