API字典 / 分账（账单及资金查询） / 获取分账退款账单下载链接API

获取分账退款账单下载链接API

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

微信支付按天提供分账退款文件，商户可以通过该接口获取账单文件的下载地址。文件内包含分账退款相关的金额、时间等信息，供商户核对到账等情况。

注意：

• 微信侧未成功的分账单不会出现在对账单中；

• 对账单中涉及金额的字段单位为“元”。

• 分账对账单接口只支持下载90天以内的账单。

1. 接口说明

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

请求URL：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/refunds/bill-download-url

请求方式：GET

Path指该参数为路径参数

Query指该参数为URL参数

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

2. 请求参数

参数名	变量	类型[长度限制]	必填	描述
二级商户号	sub_mchid	string[1, 32]	否	Query若商户是直连商户： - 无需填写该字段。若商户是服务商/机构： - 不填则默认返回服务商/机构下所有账单数据； - 如需下载某个二级商户下的账单数据，则该字段必填示例值：19000000001
账单日期	bill_date	string[10, 10]	是	Query格式yyyy-MM-DD 分账对账单接口只支持下载90天以内的账单。示例值：2020-01-01

请求示例

URL


https://api.mch.weixin.qq.com/v3/global/profit-sharing/refunds/bill-download-url?sub_mchid=19000000001&bill_date=2020-01-01


{
    "account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
    "appid": "wx78898sdfwe9888835", 
    "type": "PERSONAL_OPENID", 
    "sub_mchid": "999968480"
}


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


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

3. 返回参数

参数名	变量	类型[长度限制]	必填	描述
下载地址	download_url	string[1, 2048]	是	供下一步请求账单文件的下载地址，该地址30s内有效示例值：https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx

返回示例

正常示例


{
  "download_url": "https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx"
}


{
    "account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
    "appid": "wx78898sdfwe9888835", 
    "type": "PERSONAL_OPENID", 
    "sub_mchid": "999968480"
}


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


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

文件格式说明

• 账单文件包括明细数据和汇总数据两部分，每一部分都包含一行表头和若干行具体数据；

• 明细数据每一行对应一笔分账，同时每一个数据前加入了字符`，以避免数据被Excel按科学计数法处理。如需汇总金额等数据，可以批量替换掉该字符。

• 数据头的格式为：Refund apply time,Refund success time,Wechat refund number(refund_id),Vendor refund number(out_refund_no),Wechat order number(transaction_id),Vendor order number(out_transaction_id),Refund amount(refund_fee),Currency type,Coupon refund amount,Payer's refund amount,Payer's refund currency type,Rate,Refund source,Refund source type,Refund source amount,Refund source fee in RMB,Refund settlement currency type,Refund exchange rate,Refund source settlement amount,Refund source fee in settlement currency type; 对应的含义见下表：

变量	字段名	描述
Refund apply time	退款申请时间	指该笔交易发起退款时间，格式为YYYY-MM-DD HH:MM:SS，如2015-01-01 10:00:00 示例值：2015-01-01 10:00:00
Refund success time	退款成功时间	指该笔交易退款成功时间，格式为YYYY-MM-DD HH:MM:SS，如2015-01-01 10:00:00 示例值：2015-01-01 10:00:00
Wechat refund number(refund_id)	微信退款单号	微信支付为该笔退款分配的退款单号示例值：5050000008201712143733500002
Vendor refund number(out_refund_no)	商户退款单号	商户发起退款时填入的商户退款单号示例值：ST175HQWa0
Wechat order number(transaction_id)	微信订单号	微信支付为该笔退款对应的订单分配的订单号示例值：4200000008201712143733500001
Vendor order number(out_transaction_id)	商户订单号	商户传入的该笔订单（或该笔退款对应的订单）的商户订单号，对应下单接口里的out_trade_no字段示例值：test1
Refund amount(refund_fee)	退款单金额	标价币种对应的退款金额示例值：0.00
Currency type	标价币种	商品标价货币类型，符合ISO 4217标准的三位字母代码，如CNY 示例值：CNY
Coupon refund amount	代金券或立减优惠金额	该笔订单中使用的微信支付代金券金额（包括充值券和免充值券），单位元，保留到小数点后2位示例值：0.00
Payer's refund amount	用户支付退款金额	用户支付币种对应的退款总金额示例值：0.00
Payer's refund currency type	用户支付退款币种	用户支付货币类型，符合ISO 4217标准的三位字母代码，如CNY 示例值：CNY
Rate	手续费费率	该笔交易计费所使用的费率，百分数示例值：0.50%
Refund source	退款出资来源	指一笔分账退款单的退款资金来源，枚举值如下： 1、可垫付退款额度 FUNDS_REFUNDABLE_BALANCE 2、订单未分可退余额 ORDER_REFUNDABLE_BALANCE 示例值：ORDER_REFUNDABLE_BALANCE
Refund source type	退款出资来源组合	指一笔分账退款单的退款资金来源类型，有两种类型： 1）可能是单一来源，比如：一笔100元的退款单，全部使用"订单未分可退余额"完成退款，则展示“SINGLE_SOURCE”； 2）可能是组合来源，比如：一笔100元的退款单，30元从“订单未分可退余额”中出资，70元从“可垫付退款额度”中出资，则展示“PACKAGE”。当通过组合“PACKAGE”的方式执行退款，则需关注同一笔退款当在账单中将呈现多条记录。枚举值： 1、PACKAGE 2、SINGLE_SOURCE 示例值：PACKAGE
Refund source amount	退款出资额（RMB）	指一笔分账退款单，每项指定的“退款出资来源”实际出资用于退款的金额。示例值：0.00
Refund source fee in RMB	退款出资额手续费（RMB）	指一笔分账退款单，每部分退款出资额，包含的手续费金额示例值：-0.02
Refund settlement currency type	退款结算币种	商户发起退款时的货币类型，符合ISO 4217标准的三位字母代码，如CNY 示例值：CNY
Refund exchange rate	退款汇率	退款汇率，外币兑换RMB的比例乘以10的8次方即为此值，例如美元兑换人民币的比例为6.5，则rate=650000000 示例值：650000000 注意：退款汇率值，取退款成功时点的市场汇率，汇率价格由相关合作银行提供。
Refund source settlement amount	退款出资额结算金额	指一笔分账退款单，每部分退款出资额，对应的结算外币金额，特别说明： 1、退款出资源来自“可垫付退款额度（FUNDS_REFUNDABLE_BALANCE ） ”，属于使用待出境结算资金扎差退款，需计算外币结算金额。 2、退款出资源来自“订单未分可退余额（ORDER_REFUNDABLE_BALANCE）”，属于未出境部分的资金，不会影响结算资金，该值为空。示例值：0.00
Refund source fee in settlement currency type	退款出资额手续费（结算货币）	指一笔分账退款单，每部分退款出资额，对应的结算外币结算手续费。 1、退款出资源来自“可垫付退款额度（FUNDS_REFUNDABLE_BALANCE ） ”，需计算外币手续费。 2、退款出资源来自“订单未分可退余额（ORDER_REFUNDABLE_BALANCE）”，该值为空。示例值：-0.00

账单内容示例


Refund apply time,Refund success time,Wechat refund number(refund_id),Vendor refund number(out_refund_no),Wechat order number(transaction_id),Vendor order number(out_transaction_id),Refund amount(refund_fee),Currency type,Coupon refund amount,Payer's refund amount,Payer's refund currency type,Rate,Refund source,Refund source type,Refund source amount,Refund source fee in RMB,Refund settlement currency type,Refund exchange rate,Refund source settlement amount,Refund source fee in settlement currency type
`2022-07-26 23:08:30,`2022-07-26 23:08:38,`50202102632022072601880685005,`test00011115_001,`4200000002202207268931261193,`test00011115,`400.00,`CNY,`20.00,`400.00,`CNY,`0.50%,`FUNDS_REFUNDABLE_BALANCE,`PACKAGE,`200.00,`-1.00000,`HKD,`86500000,`231.21000,`-0.87000


{
    "account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
    "appid": "wx78898sdfwe9888835", 
    "type": "PERSONAL_OPENID", 
    "sub_mchid": "999968480"
}


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


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

4. 错误码

状态码	错误码	描述	解决方案
400	NO_STATEMENT_EXIST	请求的账单文件不存在	请检查当前商户号是否在指定日期有处理成功的分账指令单
400	STATEMENT_CREATING	账单生成中	请先检查当前商户号在指定日期内是否有处理成功的分账指令单，若有，则在T+1日上午10点后再重新下载
403	NO_AUTH	商户父子关系不存在，请使用正确的二级商户号发起请求	请检查二级商户号(sub_mchid)是否填写正确
403	NO_AUTH	商户未签约境外分账产品能力	请参考产品流程和接入准备，确认商户具有分账权限后再发起请求
403	NO_AUTH	商户已开通分账产品能力，等待生效中(一般为第二天才生效)	开通分账产品能力当天不能发起分账，请等待第二天后发起请求

页面导航

语言

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

支付产品

资金类产品

其他产品

获取分账退款账单下载链接API

1. 接口说明

2. 请求参数

请求示例

3. 返回参数

返回示例

文件格式说明

4. 错误码