Merchant recharge refund balance inquiry
Update Time:2024.11.21Merchants and institutions can call this interface to query the real-time balance and currency of foreign currency account for their recharge refunds.Institutions and service providers can also call this interface to query the real-time balance and currency of foreign currency account for the special merchant's recharge refunds.
1. API Intro
Applicable object: Common mode Institutional mode
Request URL:https://apihk.mch.weixin.qq.com/v3/global/refund/recharge-balance
OR
https://apihk.mch.weixin.qq.com/v3/global/refund/partner/recharge-balance/sub-mchid/{sub_mchid}
Request method: GET
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.
2. Request Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
special-merchant ID | sub_mchid | string[1,32] | No | Path The special merchant ID assigned by WeChat Pay is used by the service provider agent to query the balance of recharge refunds from a special merchant |
Request Example
Common mode
Institutional mode
3. Response Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
The available balance of the account | remaining_amount | integer | Yes | The available balance of foreign currency account for recharge refunds is in the smallest currency unit and must be an integer. |
currency | currency | string[3, 3] | Yes | The currency of foreign currency account for recharge refunds is a three-letter alphabetic code compliant with ISO 4217 standard. Example: 888 |
Response Example
4. Error Codes
Error Message | Description | Solution |
---|---|---|
PARAM_ERROR | Request parameter was not properly filled in as instructed. | Invalid request parameter. Re-check the parameter and then call the refund request again. |
INVALID_REQUEST | Invalid request | Check your program based on the error message returned by the API. |
SIGN_ERROR | Signature error | Check if signature parameters and methods meet the algorithm requirements. |
SYSTEM_ERROR | Errors returned from the API | Try call the API again. |