支付宝小程序API 商户会员卡
my.addCardAuth
小程序唤起会员开卡授权页面。
注意: 此 API 暂仅支持企业支付宝账户使用。
示例代码
my.addCardAuth({
url: '从 openapi 接口获取到的 url',
success: (res) => {
my.alert({content: '授权成功'});
},
fail: (res) => {
my.alert({content: '授权失败'});
},
});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
url | String | 是 | 开卡授权的页面地址,从接口获取。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
领卡成功
入参为 Object 类型,属性如下:
属性 | 类型 | 说明 |
---|---|---|
success | Boolean | true 表示领卡成功。 |
resultStatus | String | 9000 表示成功。 |
result | Object | 结果内容。 |
领卡成功的 result 属性说明
属性 | 类型 | 说明 |
---|---|---|
app_id | String | 应用id |
auth_code | String | 授权码,用于换取 authtoken。 |
state | String | 授权的 state。 |
scope | String | 授权 scope。 |
template_id | String | 会员卡模板 ID。 |
request_id | String | 会员卡表单信息请求 ID。 |
out_string | String | 会员卡领卡链接透传参数。 |
领卡失败
入参为 Object 类型,属性如下:
属性 | 类型 | 说明 |
---|---|---|
success | Boolean | false 表示领卡失败。 |
code | String | 失败的错误码。 |
领卡失败 code 错误码
错误码 | 类型 | 说明 |
---|---|---|
JSAPI_SERVICE_TERMINATED | String | 用户取消。 |
JSAPI_PARAM_INVALID | String | URL 为空或非法参数。 |
JSAPI_SYSTEM_ERROR | String | 系统错误。 |
IoT 小程序错误码
错误码 | 类型 | 说明 | 解决方案 |
---|---|---|---|
ILLEGAL_NULL_ARGUMENT | String | 非法空参数。 | 通过 alipay.marketing.card.activateurl.apply 接口生成的领卡链接,剔除 callback 参数,并对领卡链接做 urlDecode 处理。 |
INVALID_APPLY_CARD_LINK | String | 非法的开卡链接。 | 通过 alipay.marketing.card.activateurl.apply 接口生成的领卡链接,剔除 callback 参数,并对领卡链接做 urlDecode 处理。 |
OPEN_FORM_TEMPLATE_NOT_EXIST | String | 开放表单配置信息不存在。 | 调用 alipay.marketing.card.formtemplate.set 接口配置表单信息。 |
ALREADY_ACTIVE_CARD | String | 会员已有会员卡。 | 如需测试重新领取,可到支付宝卡包中删除会员卡,重新领取。 |
OPEN_FORM_FIELD_NOT_PERMITTED | String | 表单字段商家无权限。 | 后台申请对应缺失字段的权限。 |
OPEN_FORM_USER_LACK_INFO | String | 当前表单用户信息缺失。会员卡表单设置姓名、手机号等字段,但是会员卡应用下没有这些字段的权限。支付宝缺少此用户的表单信息,无法获取到信息。 | 后台申请对应缺失字段的权限。建议用户进行实名认证,补充缺少的姓名、手机号等信息。 |
SYSTEM_ERROR | String | 系统异常。 | 建议稍后重试。 |
my.openCardDetail
打开当前用户的某张卡的详情页。有关支付宝卡包详细功能。
支付宝特色 API,支持 my.ap.openCardDetail 调用。
注意:此 API 暂仅支持企业支付宝账户使用。
示例代码
//传入passId来打开
my.openCardDetail({passId:"11xxxxx"});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
passId | String | 是 | 卡实例 ID |
passId 获取方式
\1. 通过 alipass 创建的卡
调用 alipay.pass.instance.add(支付宝 pass 新建卡券实例接口)接口,在出参“result”中可获取。
\2. 通过会员卡创建的卡
调用 alipay.marketing.card.query(会员卡查询)接口,在 scheme_url 中可获取,具体参数为“p=xxx”,xxx 即为passId。
my.openCardList
打开支付宝卡列表。有关支付宝卡包详细功能。
支付宝特色 API,支持 my.ap.openCardList 调用。
注意:此 API 暂仅支持企业支付宝账户使用。
示例说明
my.openCardList();
my.openMerchantCardList
打开当前用户的某个商户的卡列表。有关支付宝卡包详细功能。
支付宝特色 API ,支持 my.ap.openMerchantCardList 调用。
注意:此 API 暂仅支持企业支付宝账户使用。
示例代码
my.openMerchantCardList({partnerId:'2088xxxxx'});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
partnerId | String | 是 | 商户编号。 |