查询订单剩余可退款金额
更新时间:2025.03.03若商户对于一笔分账支付订单发起多次分账后,可通过该API查询该笔订单的剩余未分的可退款金额和可使用垫付资金退款的金额。
|
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 微信支付分配的商户号,请与微信支付订单的二级商户号保持一致。(直连商户不需要,服务商/机构模式下必填) |
微信支付订单号 | transaction_id | string[1, 32] | 是 | Path 微信支付订单号 |
请求示例
URL
3. 返回参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
微信支付订单号 | transaction_id | string[1, 32] | 是 | 微信支付订单号 |
订单剩余可退款金额 | refundable_amount | int | 是 | 订单中被冻结在商户账户中可用于退款的金额,单位为币种最小单位(目前为人民币金额,单位为分)。 |
货币类型 | currency | string[1, 10] | 是 | 目前只支持人民币,"CNY". |
订单剩余可使用垫付资金退款的金额 | funds_refundable_amount | int | 否 | 订单剩余可以使用【可垫付退款】额度请求退款的金额(人民币金额,单位为分)。 |
返回示例
正常示例
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后重试 |