# auth.getPaidUnionId

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Obtains the UnionId of a user after the user completes payment, without needing user authorization. This API supports Query on Third-Party Platform Agents.

• Note: The API needs to be called after the user completes payment, and takes effect within five minutes after the payment.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

Valid values of errcode

# How to Use

Use either of the following methods:

1. WeChat Pay order number (transaction_id):

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

2. WeChat Pay merchant order number and WeChat Pay merchant ID (out_trade_no and 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

# Return Data Example

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

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.auth.getPaidUnionId

You need to configure the permissions for the auth.getPaidUnionId API via config.json. Details

# Request Parameters

# Return Value

# Object

JSON data package that is returned

Valid values of errCode

# Exceptions

# Object

Thrown Exceptions

Valid values of errCode

# Request Example

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: ''
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Return Data Example

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