微信小程序 getPaidUnionId

2022-05-10 16:20 更新

auth.getPaidUnionId

本接口應(yīng)在服務(wù)器端調(diào)用,詳細說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

用戶支付完成后,獲取該用戶的 UnionId,無需用戶授權(quán)。本接口支持第三方平臺代理查詢。

  • 注意:調(diào)用前需要用戶完成支付,且在支付后的五分鐘內(nèi)有效。

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID

請求參數(shù)

屬性 類型 默認值 必填 說明
access_token string 接口調(diào)用憑證
openid string 支付用戶唯一標識
transaction_id string 微信支付訂單號
mch_id string 微信支付分配的商戶號,和商戶訂單號配合使用
out_trade_no string 微信支付商戶訂單號,和商戶號配合使用

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
unionid string 用戶唯一標識,調(diào)用成功后返回
errcode number 錯誤碼
errmsg string 錯誤信息

errcode 的合法值

說明 最低版本
-1 系統(tǒng)繁忙,此時請開發(fā)者稍候再試
0 請求成功
40003 openid 錯誤
89002 沒有綁定開放平臺帳號
89300 訂單無效

使用說明

以下兩種方式任選其一。

  1. 微信支付訂單號(transaction_id):
https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&transaction_id=TRANSACTION_ID
  1. 微信支付商戶訂單號和微信支付商戶號(out_trade_no 及 mch_id):
 https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&mch_id=MCH_ID&out_trade_no=OUT_TRADE_NO

返回數(shù)據(jù)示例

{
  "unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk",
  "errcode": 0,
  "errmsg": "ok"
}

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.auth.getPaidUnionId
需在 config.json 中配置 auth.getPaidUnionId API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認值 必填 說明
openid string 支付用戶唯一標識
transactionId string 微信支付訂單號
mchId string 微信支付分配的商戶號,和商戶訂單號配合使用
outTradeNo string 微信支付商戶訂單號,和商戶號配合使用

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
unionid string 用戶唯一標識,調(diào)用成功后返回
errCode number 錯誤碼
errMsg string 錯誤信息

errCode 的合法值

說明 最低版本
0 成功

異常

Object

拋出的異常

屬性 類型 說明
errCode number 錯誤碼
errMsg string 錯誤信息

errCode 的合法值

說明 最低版本
-1 系統(tǒng)繁忙,此時請開發(fā)者稍候再試
40003 openid 錯誤
89002 沒有綁定開放平臺帳號
89300 訂單無效

請求示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.auth.getPaidUnionId({
        openid: '',
        transactionId: '',
        mchId: '',
        outTradeNo: ''
      })
    return result
  } catch (err) {
    return err
  }
}

返回數(shù)據(jù)示例

{
  "unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk",
  "errCode": 0,
  "errMsg": "openapi.auth.getPaidUnionId:ok"
}


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

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號