小程序内凭证核销准备接口
my.ap.prepareUseCertificate(Object object)
基础库 2.8.12 或更高版本; 若版本较低,建议采取 兼容处理。
主体: 企业支付宝小程序 、 个人支付宝小程序
相关文档: 本地生活商品产品接入流程 、 本地生活商品快速接入 、 团购券
简介
接入流程
凭证核销
入参
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 字段值保持一致。 | |
枚举值描述兼容性1团购套餐-2代金券- | |||
amountInfo | Object | 凭证实例的金额信息。在异常场景下可能为空,需要判断是否有值才可进行使用。 | |
属性类型描述originalPriceString商品的原价,单位为元,精度为小数点后两位。如:10.00。salePriceString商品的售价,单位为元,精度为小数点后两位。如:5.00。receiptAmountString商品售价去除商家订单优惠后的商家实收,未计算收单费率等,单位为元,精度为小数点后两位。如:4.00。 |
错误码
error
属性为错误码,errorMessage
属性为错误消息。错误码 | 错误消息 | 解决方案 |
---|---|---|
50022 | 未知的错误码 {err} | 请检查参数是否正确,参考入参必填、类型和描述。 |
60000 | 凭证不存在或凭证不属于当前用户 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试。 |
60001 | 凭证不归属于该商户 | 检查请求参数正确性或指定有权限的 belongMerchantId 。 |
60002 | 凭证已核销或作废 | 凭证不可使用。 |
60003 | 凭证券码查询异常 | 请检查凭证券码是否正确;或可能发生了网络或者系统异常,导致服务调用失败,请稍后重试。 |
60004 | 请求限流 | 请稍后重试,或联系技术支持。 |
60005 | 系统繁忙 | 请稍后重试。 |
代码示例
修改于 2023-11-22 01:58:42