my.ap.prepareusecertificate(object object)
基础库 或更高版本; 若版本较低,建议采取 兼容处理 。
小程序开发者工具: 支持。ide 3.9.10 版本开始支持
主体: 企业支付宝小程序 、 个人支付宝小程序
相关文档: 本地生活商品产品接入流程 、 本地生活商品快速接入 、 团购券
本地生活商品凭证核销准备。
凭证核销
是否必须: 是。
使用 主账号 登录 ,选择当前开发的小程序,根据下面的说明进行相关开发配置:
-
接口加签方式:必填
-
应用网关:必填
-
支付宝网关:必填
-
接口内容加密方式:选填,建议配置
-
服务器ip白名单:选填,涉及到敏感操作时建议配置
具体可参考文档 开发设置。
是否必须: 是。
在服务端通过调用以下接口接入本地生活商品
-
通过类目查询商品模版:alipay.open.app.localitem.template.query
-
通过商品模版创建本地生活商品:alipay.open.app.localitem.create
更多本地生活商品操作请查看 本地生活商品接口开发接入
是否必须: 是。
服务端调用 alipay.marketing.certificate.user.batchquery 查询, 返回数据中的 certificate_id 即为 用户凭证 id 。
是否必须: 是。
在小程序中调用 api ,传入上一步获取的凭证 id 。调用后会返回凭证核销所需要的部分参数,如:orderid 。
object object
查看示例
属性 | 类型 | 默认值 | 必填 | 描述 |
---|---|---|---|---|
certificateid | string | - | 是 | 凭证 id 。可通过服务端接口 alipay.marketing.certificate.user.batchquery 获取 |
belongmerchantid | string | 当前小程序请求商户 id | 否 | 凭证归属商户 id(支付宝 id), 与当前商户必须是同集团商户。如:2088721473131xxx 。 |
success | function | - | 否 | 调用成功的回调函数。 |
fail | function | - | 否 | 调用失败的回调函数。 |
complete | function | - | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
参数
object res
属性 | 类型 | 描述 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
encryptedcode | string | 加密 code |
|||||||||||||
validbegintime | number | 有效期开始时间 |
|||||||||||||
validendtime | number | 有效期结束时间 |
|||||||||||||
certificateid | string | 用户凭证 id |
|||||||||||||
itemid | string | 支付宝平台侧商品 id |
|||||||||||||
outitemid | string | 商家侧商品 id |
|||||||||||||
skuid | string | 支付宝平台侧 skuid |
|||||||||||||
outskuid | string | 商家侧 skuid |
|||||||||||||
orderid | string | 支付宝订单 id |
|||||||||||||
title | string | 商品名称。最少不低于 3 个字符,最长不超过 60 个字符。 |
|||||||||||||
itemtype | string | 商品模版类型。此字段与使用 alipay.open.app.localitem.create 接口创建本地生活商品时传入的 item_type 字段值保持一致。 |
|||||||||||||
|
|||||||||||||||
amountinfo | object | 凭证实例的金额信息。在异常场景下可能为空,需要判断是否有值才可进行使用。 |
|||||||||||||
|
|||||||||||||||
timescardinfo | object | 次卡信息。 |
|||||||||||||
|
jscertificateserialinfo
属性 | 类型 | 描述 |
---|---|---|
serialno | string | 次序号。 |
status | string | 次序号状态。 |
amountinfo | array |
次序号的金额信息。 |
jscertificateamountinfo
属性 | 类型 | 描述 |
---|---|---|
originalprice | string | 商品的原价,单位为元,精度为小数点后两位。 |
saleprice | string | 商品的售价,单位为元,精度为小数点后两位。 |
receiptamount | string | 商品售价去除商家订单优惠后的商家实收,未计算收单费率等,单位为元,精度为小数点后两位。 |
fail 回调的参数为 object,error
属性为错误码,errormessage
属性为错误消息。
错误码 | 错误消息 | 凯发app官方网站的解决方案 |
---|---|---|
50022 | 未知的错误码 {err} |
请检查参数是否正确,参考入参必填、类型和描述。 |
60000 | 凭证不存在或凭证不属于当前用户 |
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试。 |
60001 | 凭证不归属于该商户 |
检查请求参数正确性或指定有权限的 belongmerchantid 。 |
60002 | 凭证已核销或作废 |
凭证不可使用。 |
60003 | 凭证券码查询异常 |
请检查凭证券码是否正确;或可能发生了网络或者系统异常,导致服务调用失败,请稍后重试。 |
60004 | 请求限流 |
请稍后重试,或联系凯发app官方网站的技术支持。 |
60005 | 系统繁忙 |
请稍后重试。 |
my.ap.prepareusecertificate({
certificateid: "20230529004450057266000000xx",
success: function(res) {
console.log(res);
},
fail: function(err) {
console.log(err);
}
});