支付寶小程序:三方開放能力 API概覽

小編:啊南 678閱讀 2020.12.28

說明

此為第三方應用場景下,小程序可接入開放能力的簡要介紹和相關 API。

在代商戶接入支付寶開放能力時,請以第三方應用代商家小程序調用的方式調用支付寶 OPEN API。

關于代調用方式說明:

  • 模板開發模式,請參見 代調用 OPEN API 說明。

  • 應用授權代開發模式,請參見 ISV 實施小程序。

基礎能力

能力名稱

能力簡述

支持賬戶類型

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 (文本風險識別(小程序端))

關聯標簽:
5544444