API字典 / 分账（发起退款） / 查询订单剩余可退款金额API

查询订单剩余可退款金额API

最新更新时间：2024.01.25 版本说明

若商户对于一笔分账支付订单发起多次分账后，可通过该API查询该笔订单的剩余未分的可退款金额和可使用垫付资金退款的金额。

注意：

• 一笔分账支付订单支付成功后，该笔订单款项会被冻结在商户账户中，商户可通过请求分账指令或解冻剩余资金指令来执行分出或解冻操作，也可用于用户退款（商户退款API）。
可通过查询剩余待分账金额查询到该笔订单已被冻结、商户可用于分出或解冻的金额（该金额为订单结算扣除平台交易手续费之后的金额）；
而该API提供的剩余未分可退款金额是指该笔订单已被冻结、可用于退还给用户的货款金额（包含平台退回的相应比例的手续费）。

• 比如，若一笔订单金额为 100 元人民币，手续费比例为 1%，则交易手续费为 1 元。此时，该订单的剩余待分账金额为：99 元，剩余未分可退款为 100 元。
若商户通过请求分账API指定分账出境 49.5 元，此时，该订单的剩余待分账金额为：99-49.5=49.5 元，剩余未分可退款金额为 49.5 + 49.5 / (100 (1 - 1%)) = 50 元（剩余待分账金额+对应部分应退还的手续费），可使用垫付资金退款的金额也为: 50 元（分账出境金额 + 对应部分应退还手续）

• 手续费的计算以该接口返回为准，平台侧会保证，当一笔订单发生全额退款时，退款退还的手续费等于原订单支付所收手续费。

1. 接口说明

适用对象：直连模式机构模式

请求URL：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/{transaction_id}/refundable-amounts

请求方式：GET

Path指该参数为路径参数

Query指该参数为URL参数

Body指该参数需在请求JSON传参

2. 请求参数

参数名	变量	类型[长度限制]	必填	描述
二级商户号	sub_mchid	string[1, 32]	否	Query微信支付分配的商户号，请与微信支付订单的二级商户号保持一致。（直连商户不需要，服务商/机构模式下必填）示例值：1900000109
微信支付订单号	transaction_id	string[1, 32]	是	Path微信支付订单号示例值：4208450740201411110007820472

请求示例

URL


https://api.mch.weixin.qq.com/v3/global/profit-sharing/transactions/4208450740201411110007820472/refundable-amounts?sub_mchid=1900000109


									{
										"stock_id": "PHP",
										"offset": 10,
										"limit": 10,
									}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

3. 返回参数

参数名	变量	类型[长度限制]	必填	描述
微信支付订单号	transaction_id	string[1, 32]	是	微信支付订单号示例值：4208450740201411110007820472
订单剩余可退款金额	refundable_amount	int	是	订单中被冻结在商户账户中可用于退款的金额，单位为币种最小单位（目前为人民币金额，单位为分）。资金使用说明：若订单冻结金额用于退款，则订单剩余可分账金额也会相应减少。示例值：1000
货币类型	currency	string[1, 10]	是	目前只支持人民币，"CNY". 示例值：CNY
订单剩余可使用垫付资金退款的金额	funds_refundable_amount	int	否	订单剩余可以使用【可垫付退款】额度请求退款的金额，仅已经解冻出境部分可以使用垫付资金发起退款（目前为人民币金额，单位为分）。资金使用说明：若订单发起垫付退款，则订单剩余可使用垫付资金退款的金额也相应减少。示例值：100

返回示例

正常示例


{
  "currency": "CNY",
  "refundable_amount": 1000,
  "transaction_id": "4208450740201411110007820472"
  "funds_refundable_amount": "100"
}


									{
										"stock_id": "PHP",
										"offset": 10,
										"limit": 10,
									}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

4. 错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	该订单不支持分账	请检查微信支付订单号是否填错，并确认在调用下单API之前执行调用分账标记API成功
403	NO_AUTH	商户未签约境外分账产品能力	请参考产品流程和接入准备，确认商户具有分账权限后再发起请求
403	NO_AUTH	商户已开通分账产品能力，等待生效中(一般为第二天才生效)	开通分账产品能力当天不能发起分账，请等待第二天后发起请求
403	NO_AUTH	商户父子关系不存在，请使用正确的二级商户号发起请求	请检查二级商户号(sub_mchid)是否填写正确
400	INVALID_REQUEST	商户信息与订单商户信息不一致	请检查二级商户号(sub_mchid)/微信支付单号(transaction_id)是否填写正确
500	SYSYTEM_ERROR	商户发起分账请求指定的微信支付订单资金冻结流程还未完成，请稍后重试	用户支付完成后即会触发对该笔分账支付单的资金冻结流程，建议商户可在3~5min后重试

页面导航

语言

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

支付产品

资金类产品

其他产品

查询订单剩余可退款金额API

1. 接口说明

2. 请求参数

请求示例

3. 返回参数

返回示例

4. 错误码