Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

Remaining Funds Amount to be Distributed Query API

Latest update time:2022.05.18 Release notes


Call API to query the transaction's remaining funds amount to be distributed.

API Intro

Request Url:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/{transaction_id}/amounts

Request method:GET

API rules: https://wechatpay-api.gitbook.io/wechatpay-api-v3

Applicable object:Common modeInstitutional mode

path parameter is a path parameter.

query parameter needs to be passed in the request URL.

body parameter needs to be passed in the request JSON.

Request Parameters

Name Variable Name Type Required Description
Sub-merchant ID sub_mchid string[1, 32] No query Sub-merchant ID allocated by Weixin Pay. It needs to be consistent with the sub-merchant ID in the transaction of Weixin Pay.
Note: Only forInstitutional mode
Example:1900000109
Weixin Pay transaction ID transaction_id string[1, 32] Yes path Weixin Pay transaction ID
Example:4208450740201411110007820472

Request Sample

Example:

https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/4208450740201411110007820472/amounts?sub_mchid=1900000109
{
  "currency": "CNY",
  "out_trade_no": "P20150806125346",
  "sub_mchid": "1900000109"
}

Return Parameters

Name Variable Name Type Required Description
Weixin Pay order No. transaction_id string[1, 32] Yes Weixin Pay transaction ID
Example:4208450740201411110007820472
Remaining funds amount to be distributed unsplit_amount int Yes Remaining funds amount to be distributed, in the minimum unit of currency. (CNY Currently, unit: cents).
Example:1000
Currency type currency string[1, 10] Yes Only CNY is supported currently.
Example: CNY

Return Example


{
  "currency": "CNY",
  "transaction_id": "4208450740201411110007820472",
  "unsplit_amount": 1000
}
 
                                
{
"code":"SYSTEM_ERROR",
"message":"Parameter error"
}

Release notes

close
V1.0
2022.05.18
1. Remaining Funds Amount to be Distributed Query API released online

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global