支付寶小程序API 跳轉(zhuǎn)支付寶應(yīng)用或頁面

2020-09-16 15:50 更新

my.ap.navigateToAlipayPage

版本需求:基礎(chǔ)庫 1.10.0 或更高版本;支付寶客戶端 10.1.32 或更高版本 ,若支付寶客戶端版本較低,建議做 兼容處理。

小程序中跳轉(zhuǎn)到支付寶官方業(yè)務(wù)或運營活動頁面。

小程序之間相互跳轉(zhuǎn),請使用專有接口:my.navigateToMiniProgram。

注意:此 API 暫僅支持企業(yè)支付寶賬戶使用。

入?yún)?/h4>

Object 類型,屬性如下:

屬性 類型 必填 描述 備注
appCode String 是(和 path 二選一) 要跳轉(zhuǎn)的支付寶官方業(yè)務(wù),例如付款碼,appCode: 'payCode',詳見下方 appCode 說明。 跳轉(zhuǎn)支付寶掃一掃、收到的紅包頁面、愛攢油頁面、小程序快報生活號、螞蟻森林、螞蟻莊園、某只股票的詳情頁,請使用 appCode 屬性。支付寶客戶端 10.1.62 版本開始支持。個人小程序暫不支持跳轉(zhuǎn)付款碼頁面。
path String 是(和appCode 二選一) 要跳轉(zhuǎn)的支付寶業(yè)務(wù)、運營活動 scheme 或 url,如果 url 中帶有參數(shù),請務(wù)必先將整個 url 做 encode 處理。 跳轉(zhuǎn)除 appCode 參數(shù)涵蓋的頁面,請使用 path 屬性。可跳轉(zhuǎn)域名以 https://render.alipay.com/p 開頭的支付寶業(yè)務(wù)、運營頁面。
appParams Object appCode 配套參數(shù),需要和 appCode 搭配使用。目前已開放的跳轉(zhuǎn)頁面,均無需配置 appParams 參數(shù),appParams 為 {} 即可。(見示例代碼 2) 支付寶客戶端 10.1.62 版本開始支持。

appCode 參數(shù)說明

入?yún)?Object 類型,屬性如下:

appCode appParams 描述
alipayScan {} 打開支付寶掃一掃。
redPacket {} 打開收到的紅包頁面。
collectOil {} 打開愛攢油頁面。
tinyAppSHH {} 打開小程序快報生活號。
antForest autoShowProps:是否打開背包,可空。 打開螞蟻森林。
antFarm {} 打開螞蟻莊園。
stockDetail stockType:股票類型,ES-個股,MRI-指數(shù);market:所在市場,SH-滬市,SZ-深,A\O\N\USI - 美股市場,HK-港股市場;symbol:股票代碼;name:股票名稱,需要encode。 打開某只股票的詳情頁。
payCode {} 打開支付寶付款碼(注意:個人小程序暫不支持跳轉(zhuǎn)付款碼頁面。)

success 回調(diào)函數(shù)

入?yún)?Object 類型,屬性如下:

屬性 類型 描述
success Boolean 跳轉(zhuǎn)成功。

fail 回調(diào)函數(shù)

入?yún)?Object 類型,屬性如下:

屬性 類型 描述
error String 錯誤碼。
errorMessage String 錯誤信息。

示例代碼

  1. 使用 appCode 屬性:

    my.ap.navigateToAlipayPage({
    appCode:'tinyAppSHH',
    appParams: {},
    success:(res) => {
        my.alert({content:'成功:'+JSON.stringify(res)});
    },
    fail:(res) => {
        my.alert({content:'失?。?+JSON.stringify(res)});
    }
}); 
// 打開支付寶掃一掃
my.ap.navigateToAlipayPage({
    appCode:'alipayScan',
    success:(res) => {
        my.alert({content:'成功:'+JSON.stringify(res)});
    },
    fail:(res) => {
        my.alert({content:'失?。?+JSON.stringify(res)});
    }
});
// 打開螞蟻森林
my.ap.navigateToAlipayPage({
    appCode:'antForest',
    appParams: {
        autoShowProps:1 //可選參數(shù),等1時,默認打開開啟森林背包
    },
  success:(res) => {
        my.alert({content:'成功:'+JSON.stringify(res)});
    },
    fail:(res) => {
        my.alert({content:'失?。?+JSON.stringify(res)});
    }
});// 打開股票詳情
my.ap.navigateToAlipayPage({
   'appCode':"stockDetail",
   'appParams':{
        'stockType':"ES", //股票類型,ES-個股,MRI-指數(shù)
        'market':"N", //所在市場,SH-滬市,SZ-深,A\O\N\USI - 美股市場,HK-港股市場
        'symbol':"BABA", //股票代碼
        'name':"阿里巴巴" //股票名稱
    },
    success:(res) => {
        my.alert({content:'成功:'+JSON.stringify(res)});
    },
    fail:(res) => {
        my.alert({content:'失?。?+JSON.stringify(res)});
    }
});
  1. 使用 path 屬性,通過 scheme 跳轉(zhuǎn):

  • scheme 可以理解為一種特殊的URI,格式與 URI 相同。
  • 在 scheme 中配置的啟動參數(shù)需要與 appId 同級,如果啟動參數(shù)的值包含特殊字符,必須注意需要經(jīng)過 encode 后再傳遞。

my.ap.navigateToAlipayPage({
    // 例如跳轉(zhuǎn)到共享單車頁面,其 scheme 格式為:
    // alipays://platformapi/startapp?appId=60000155&chInfo=ch_${appid},${appid} 替換為自己的16位 appid,例如:
    path:'alipays://platformapi/startapp?appId=60000155&chInfo=ch_${appid}',
    success:(res) => {
        my.alert({content:'系統(tǒng)信息' + JSON.stringify(res)});
    },
    fail:(error) => {
        my.alert({content:'系統(tǒng)信息' + JSON.stringify(error)});        
    }
})

錯誤碼

錯誤碼 描述 解決方案
2 參數(shù)錯誤,打開失敗。 檢查 H5 頁面鏈接地址 scheme 或 URL 是否有誤。檢查 appCode 入?yún)⑹欠裼锌崭?、是否填寫有誤。path 和 appCode 二選一,必填??商D(zhuǎn)域名以 https://render.alipay.com/p 開頭的支付寶業(yè)務(wù)、運營頁面(生活號文章鏈接等)。部分支付寶運營、業(yè)務(wù)頁面目前暫不開放跳轉(zhuǎn)。
4 無權(quán)限調(diào)(N22104)。 個人小程序應(yīng)用沒有開放 my.ap.navigateToAlipayPage 能力。

常見問題 FAQ

使用 my.ap.navigateToAlipayPage 是否可以跳轉(zhuǎn)基金頁面?

my.ap.navigateToAlipayPage 暫不支持跳轉(zhuǎn)基金頁面。

使用 my.ap.navigateToAlipayPage 打開 H5 頁面為何提示“參數(shù)錯誤,打開失敗”?

可能原因 解決方案
H5 頁面鏈接地址有誤。 修改錯誤 H5 頁面鏈接。
部分支付寶運營、業(yè)務(wù)頁面目前暫不開放跳轉(zhuǎn)。 -

使用 my.ap.navigateToAlipayPage 跳轉(zhuǎn)生活號文章有一個過渡空白過程,是否正常?

是正常的,屬于正常加載流程。

香港支付寶小程序支持"跳轉(zhuǎn)支付寶應(yīng)用或頁面 " my.ap.navigateToAlipayPage 嗎?

針對國際業(yè)務(wù)的特殊性,支付寶有專門的團隊支持,香港版小程序咨詢請點擊以下鏈接進行咨詢:https://global.alipay.com/open/faq.htm 。

其他有關(guān)跳轉(zhuǎn)問題的解答,請參見 小程序跳轉(zhuǎn) FAQ

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號