支付宝小程序：三方开放能力 API概览

能力名称

能力简述

支持账户类型

API

小程序二维码

生成后小程序二维码，可在线下进行贴码推广。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

alipay.open.app.qrcode.create （小程序生成推广二维码接口）

小程序订单中心

小程序商家可通过此功能回流商品，物流，服务等信息到支付宝订单中心，进行 C 端售后服务。

• 企业支付宝账户

• 个体工商户

• alipay.open.auth.token.app?（换取应用授权令牌）

• alipay.merchant.item.file.upload（商品图片上传接口）

• alipay.merchant.order.sync（tr订单数据同步接口）

• ant.merchant.expand.item.open.create （创建商品接口）

• ant.merchant.expand.item.open.modify（修改商品接口）

• ant.merchant.expand.item.open.query(查询商品接口)

• ant.merchant.expand.item.open.batchquery（批量查询商品接口）

• ant.merchant.expand.item.open.delete（删除商品接口）

小程序视频播放

通过使用小程序视频组件，开发者可以在自己的小程序里上传并播放视频。

• 企业支付宝账户

• my.createVideoContext（创建视频接口）

音频播放

通过使用?小程序音频播放?功能，开发者可以在自己的小程序里播放已上传好的音频。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

• my.createInnerAudioContext（播放前景音）

• my.getBackgroundAudioManager（播放背景音）

• my.onAudioInterruptionBegin（监听音频中断开始事件）

• my.onAudioInterruptionEnd（监听音频中断结束事件）

• my.offAudioInterruptionBegin（取消监听音频中断开始事件）

• my.offAudioInterruptionEnd（取消监听音频中断结束事件）

用户授权r

开发者通过此功能来获取用户的授权和允许，获取用户的基本信息。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

• my.getAuthCode （获取用户授权码）

• alipay.system.oauth.token（换取授权访问令牌）

小程序自定义分享

用户便捷地分享小程序到支付宝客户端内（朋友动态、支付宝好友）和其他 APP （钉钉、微博、微信、QQ）。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

onShareAppMessage（设置页面的分享信息）

蚂蚁门店管理

蚂蚁门店管理能力面向商家及服务商开放，通过调用接口，开发者可完成快速创建支付宝门店、对名下支付宝门店进行查询、关店等处理。

门店创建成功后，商家可在?商家中心?管理门店；服务商可在?服务商平台?基于自身管理的门店，为相应商家设置电子名片、推广机具、物料等辅助工具。

• 企业支付宝账户

• 个体工商户

• ant.merchant.expand.shop.query （店铺查询接口）

• ant.merchant.expand.shop.save.passed （店铺审核通过消息）

• ant.merchant.expand.shop.create（蚂蚁店铺创建）

• ant.merchant.expand.shop.modify（修改蚂蚁店铺）

• ant.merchant.expand.order.query （商户申请单查询）

• ant.merchant.expand.shop.close （蚂蚁店铺关闭）

• ant.merchant.expand.shop.save.rejected（店铺审核拒绝通过消息）

• ant.merchant.expand.indirect.image.upload（图片上传）

能力名称

能力简述

支持账户类型

API

当面付

当面付即第三方接入场景的小程序支付功能，可使用花呗分期的付款方式。

• 企业支付宝账户

• 个体工商户

• ???alipay.trade.create（统一收单交易创建接口）

• ?alipay.open.agent.facetoface.sign（代签约当面付产品）

• ?my.request（向指定服务器发起一个跨域 http 请求）?my.tradePay（小程序唤起支付）

花呗分期

第三方接入场景支持的花呗分期能力仅限标准收银台模式、单通道模式。单通道模式接入操作，请参看 接入花呗分期说明。

• 企业支付宝账户

• 个体工商户

???alipay.trade.create（统一收单交易创建接口）

能力名称

能力简述

支持账户类型

API

资金预授权

用户开启服务时先期进行资金预授权，服务完成结算时，从授权资金中扣除消费金额，返还剩余给用户。

• 企业支付宝账户

• alipay.fund.auth.order.app.freeze（线上资金授权冻结接口）

• alipay.fund.auth.order.unfreeze（资金授权解冻接口）

• alipay.fund.auth.operation.cancel（资金授权撤销接口）

• ?alipay.fund.auth.operation.detail.query（资金授权操作查询接口）

• alipay.trade.pay（统一收单交易支付接口）

• alipay.trade.query（统一收单线下交易查询）

• ?alipay.trade.refund（统一收单交易退款接口）

• ?alipay.trade.orderinfo.sync（支付宝订单信息同步接口）

• ?alipay.data.dataservice.bill.downloadurl.query（查询对账单下载地址）

• my.tradePay（小程序支付接口）

• ?alipay.trade.orderinfo.sync（资金授权订单信息同步接口）

商家分账

商家可根据自行业务特点完成与其合作方基于交易资金灵活分配，在不同场景下实现高效分润。

• 企业支付宝账户

• ?alipay.trade.royalty.relation.bind（分账关系绑定）

• alipay.trade.royalty.relation.unbind（分账关系解绑）

• alipay.trade.royalty.relation.batchquery（分账关系查询）

• alipay.trade.order.settle（统一收单交易结算接口）

• my.tradePay（小程序支付接口）

• ?alipay.trade.refund（统一收单交易退款接口）

转账到支付宝账户

商家可以通过调用接口将资金从商家的支付宝余额发放到指定账户的支付宝余额。

• 企业支付宝账户

• ?alipay.fund.trans.uni.transfer（用于向指定支付宝账户转账）?alipay.fund.trans.common.query（用于查询转账结果）

• ?alipay.fund.account.query（用于查询支付宝账户余额）

• alipay.fund.trans.order.changed?（用于转账单据状态变更后触发的通知）

能力名称

能力简述

支持账户类型

API

获取会员基础信息

在获得用户授权后，可通过接口获取用户头像、昵称、性别、所在地区等基础信息。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

• ??my.getOpenUserInfo（获取会员基础信息）

• ?my.getAuthCode（?r获取授权码）

• alipay.system.oauth.token（换取授权访问令牌）

获取会员手机号

经用户授权后，可通过接口获取支付宝会员手机号信息。

• 企业支付宝账户

my.getPhoneNumber（获取会员手机号）

获取会员收货地址

经用户授权后，可以引导用户在支付宝里设置的收货地址列表，选择收货地址并获得该地址。

• 企业支付宝账户

???my.getAddress（获取会员收货地址）

商户会员卡

企业支付宝账户帮助商家建立会员体系，开拓精准营销。

• 企业支付宝账户

• alipay.offline.material.image.upload （上传门店照片和视频接口）

• ?alipay.marketing.card.template.create（会员卡模板创建接口）

• ?alipay.marketing.card.template.modify（会员卡模板修改接口r）

• ?alipay.marketing.card.template.query（会员卡模板查询接口）

• ??alipay.marketing.card.formtemplate.set（会员卡开卡表单模板配置接口）

• ?alipay.marketing.card.activateurl.apply（获取会员卡领卡投放链接接口）

• ?alipay.marketing.card.activateform.query（查询用户提交的会员卡表单信息接口）

• ?alipay.marketing.card.open（会员卡开卡接口）

• ?alipay.marketing.card.update（会员卡更新接口）

• ?alipay.marketing.card.delete（会员卡删卡接口）

• alipay.marketing.card.query（会员卡查询接口）

身份验证

基于支付宝客户端的实人认证能力，采用人脸、眼纹、证照、姓名和身份证号多因子认证技术快速得出认证结果。

• 企业支付宝账户

• alipay.user.certify.open.query（?r身份认证记录查询）

• alipay.user.certify.open.initialize?（身份认证初始化服务）

• alipay.user.certify.open.certify（身份认证开始认证）

能力名称

能力简述

支持账户类型

API

支付宝卡包

支付宝卡包是一款可以管理电子凭证的产品聚合来自各类生活服务的票据凭证，包括各类券和票等。

• 企业支付宝账户

• ?alipay.pass.template.add（卡券模板创建接口）

• alipay.pass.template.update（卡券模板更新接口）

• ?alipay.pass.instance.add（卡券实例发放接口）

• ?alipay.pass.instance.update（卡券实例更新接口）

无资金商户优惠券

支付宝为商户提供的一种无需提前出资的优惠工具，用户可在特定的交易场景下使用支付宝付款时使用此券优惠。

• 企业支付宝账户

• 个体工商户

• alipay.marketing.cashlessvoucher.template.create（无资金券模板创建接口）

• ?alipay.marketing.cashlessvoucher.template.modify（无资金券模板修改接口）

• ?alipay.marketing.voucher.send（发券接口）

• ?alipay.marketing.voucher.templatedetail.query（查询模板详情r）

• ?alipay.marketing.voucher.templatelist.query（查询券模板列表）alipay.marketing.voucher.query（券查询）

• ?alipay.marketing.userule.pid.query（商户使用场景规则PID查询）

• ?ant.merchant.expand.merchant.storelist.query（商户外部门店查询接口）

• alipay.marketing.material.image.upload（营销图片上传接口）

• ?alipay.marketing.cashlessitemvoucher.template.create（无资金单品券创建接口）

模板消息

商家可通过消息高效触达用户，通知用户当前行为的结果及状态等。

• 企业支付宝账户

• 个人支付宝账户（含个体工商户）

???alipay.open.app.mini.templatemessage.send（小程序发送模板消息）

现金红包

商家可以在小程序场景给用户发放现金红包，增强营销。

• 企业支付宝账户

• alipay.fund.trans.uni.transfer（统一转账接口r）

• alipay.fund.trans.common.query（单据查询接口）

• alipay.fund.trans.order.changed r（单据状态变更后触发的通知接口）

能力名称

能力简述

支持账户类型

API

文本风险识别

帮助用户有效识别垃圾广告、恶意言论、黄赌毒、暴恐政等非法用户原创内容。

• 企业支付宝账户

• alipay.security.risk.content.detect（文本风险识别（服务端））

• my.textRiskIdentification （文本风险识别（小程序端））