下载交易账单
POST
/pay/downloadbill
应用场景
交易账单格式说明
1. 交易账单介绍
2. 交易账单的文件格式
字段名 | 描述 | 示例值 |
---|---|---|
明细数据 | ||
交易时间 | 指该笔交易的支付成功时间或发起退款成功时间(注:不是退款成功时间),格式为yyyy-MM-dd HH:MM:SS | 2015-01-01 10:00:00 |
公众账号ID | 发起该笔交易时使用的appid,appid是由微信给公众号或app等分配的唯一标识 | wxab8acb865bb11234 |
商户号 | 发起该笔交易下单的微信支付商户号,8~10位数字 | 1234567890 |
设备号 | 对应在下单时传入的device_info字段,没填写则留空 | casher001 |
微信订单号 | 微信支付为该笔订单(或该笔退款对应的订单)分配的订单号 | 4200000008201712143733500001 |
商户订单号 | 商户传入的该笔订单(或该笔退款对应的订单)的商户订单号,对应下单接口里的out_trade_no字段 | outtradeno001 |
用户标识 | 微信为支付用户在公众账号ID(appid)下分配的唯一标识(openid) | testxt08c-XB5-QD208X1Aid0Cbs |
交易类型 | 该笔订单(或该笔退款单对应的订单)的类型,使用英文缩写展示,包括但不限于(*后续可能新增*): MICROPAY,付款码支付 JSAPI,JSAPI支付、小程序支付 NATIVE,Native支付 APP,APP支付 FACE,刷脸支付 | NATIVE |
交易状态 | 标识该笔明细数据的类型: SUCCESS,支付成功,说明该行数据为一笔支付成功的订单 REFUND,转入退款,说明该行数据为一笔发起退款成功的退款单 REVOKED,已撤销,说明该行数据为一笔在用户支付成功后发起撤销的退款单 | SUCCESS |
付款银行 | 用户支付时使用的付款方式,包括但不限于(*后续可能新增*): XXX_CREDIT,用户使用了XXX银行的一张信用卡付款 XXX_DEBIT,用户使用了XXX银行的一张储蓄卡付款 OTHERS,用户使用了零钱/零钱通等其他付款方式 | CMB_CREDIT |
货币种类 | 货币类型,符合ISO 4217标准的三位字母代码 | CNY |
应结订单金额 | 该笔订单参与计费的应结算金额(=订单金额-用户使用的免充值券金额),如果该行数据为退款或撤销则展示0.00,单位元,保留到小数点后2位 | 8.88 |
代金券金额 | 该笔订单中使用的微信支付代金券金额(包括充值券和免充值券),如果未使用代金券、或该行数据为退款或撤销则展示0.00,单位元,保留到小数点后2位 | 0.88 |
微信退款单号 | 微信支付为该笔退款分配的退款单号,如果该行数据为订单(交易状态SUCCESS)则展示0 | 50401010122021000000038202001 |
商户退款单号 | 商户发起退款时填入的商户退款单号,如果该行数据为订单(交易状态SUCCESS)则展示0 | refundno001 |
退款金额 | 该笔退款单参与计费的应结算金额(申请退款金额-免 充值券退款金额),如果该行数据为订单则展示为0.00,非负数、单位元,保留到小数点后2位 | 6.66 |
充值券退款金额 | 退款金额中包含的充值券退款金额,如果该行数据为订单或没有充值券退款则展示为0.00,非负数、单位元,保留到小数点后2位 | 0.66 |
退款类型 | ORIGINAL—原路退款 BALANCE—转退到用户的微信支付零钱 如果该行数据为订单(交易状态SUCCESS)则留空 | ORIGINAL |
退款状态 | 生成账单文件时该笔退款的状态、出账后不会更新,如果该行数据为订单(交易状态SUCCESS),则留空 SUCCESS,退款成功 PROCESSING,退款处理中 FAIL,退款失败 CHANGE,退款异常 | SUCCESS |
商品名称 | 商户传入的该笔订单(或该笔退款对应的订单)的商品名称,对应下单接口里的body字段 | 零食 |
商户数据包 | 商户传入的该笔订单(或该笔退款对应的订单)的商户数据包,对应下单接口里的attach字段,不传时留空 | 交易收款 |
手续费 | 该笔订单/退款对应的手续费金额,订单对应正数、退款对应负数,单位元,保留小数点后2位 | 0.01 |
费率 | 该笔交易计费所使用的费率,百分数 | 0.60% |
订单金额 | 该笔订单的金额,包括用户支付金额、充值券金额、免充值券金额,如果该行数据为退款或撤销则填0.00,单位元,保留到小数点后2位 | 9.76 |
申请退款金额 | 商户发起退款的金额,包括退给用户的金额、充值券 退款金额、免充值券退款金额,如果该行数据订单则填0.00,单位元,保留到小数点后2位 | 6.66 |
费率备注 | 对计费费率的补充说明,如入驻结算规则ID、优惠费率活动ID等,可为空 | 726 |
汇总数据 | ||
总交易单数 | 该份账单内明细数据的笔数 | 200 |
应结订单总金额 | 账单内所有应结订单金额字段之和,保留小数点后2位 | 888.00 |
退款总金额 | 账单内所有退款金额字段之和,保留小数点后2位 | 666.00 |
充值券退款总金额 | 账单内所有充值券退款金额字段之和,保留小数点后2位 | 6.60 |
手续费总金额 | 账单内所有交易手续费字段之和,保留小数点后2位 | 10.00 |
订单总金额 | 账单内所有交易订单金额字段之和,保留小数点后2位 | 976.00 |
申请退款总金额 | 账单内所有申请退款金额字段之和,保留小数点后2位 | 666.00 |
转换成为\
3. 账单样例
错误码
错误码 | 名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|---|
100 | SYSTEMERROR | 下载失败 | 系统超时 | 请尝试再次查询。 |
100 | Network Traffic Limit | 网络流量限制 | 当前系统请求繁忙 | 请尝试再次查询 |
20003 | SYSTEMERROR | 下载失败 | 系统超时 | 请尝试再次查询。 |
20001 | sign error | 签名错误 | 请求参数未按要求进行填写 | 签名错误,请重新检查参数和签名密钥是否正确 |
nonce_str too long | 参数nonce_str错误 | 请求参数未按要求填写 | 参数nonce_str长度超长 | |
invalid tar_type, Only GZIP supported | 参数tar_type错误 | 请求参数未按指引进行填写 | 请重新检查参数invalid tar_typ是否正确 | |
invalid bill_type | 参数bill_type错误 | 请求参数未按指引进行填写 | 请重新检查参数bill_type是否正确 | |
invalid bill_date | 参数bill_date错误 | 请求参数未按指引进行填写 | 请重新检查参数bill_date是否符合要求 | |
require POST method | 请求方式错误 | 请求方式不符合要求 | 请求检查参数请求方式是否为post | |
empty post data | 请求报文错误 | 请求报文为空 | 请重新检查请求报文是否正确 | |
data format error | 参数格式错误 | 请求参数要求为xml格式 | 请重新检查请求参数格式是否为xml | |
missing parameter | 缺少参数 | 有必传的参数未上传 | 请重新检查是否所有必传参数都上传了,且不为空 | |
invalid appid | appid错误 | 请求参数appid有误 | 请重新检查参数appid是否正确 | |
invalid parameter | 参数错误 | 有未知的请求参数 | 请重新检查是否所有参数都与文档相符 | |
20002 | No Bill Exist | 账单不存在 | 当前商户号没有已成交的订单,不生成对账单 | 请检查当前商户号在指定日期内是否有成功的交易。 |
Bill Creating | 账单未生成 | 当前商户号没有已成交的订单或对账单尚未生成 | 请先检查当前商户号在指定日期内是否有成功的交易,如指定日期有交易则表示账单正在生成中,请在上午10点以后再下载。 | |
20007 | 当前商户号账单API权限已经关闭 | 当前商户号账单API权限已经关闭 | 当前商户号账单API权限已经关闭 | 当前商户号账单API权限已经关闭,请联系微信支付解决 |
20008 | Frequency Limited | 请求频率超过限制 | 当前IP或商户号的请求过于频繁,超过了频率限制 | 请放慢请求速度,稍后再次查询 |
20100 | system error | 下载失败 | 系统超时 | 请尝试再次查询。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/pay/downloadbill' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
<appid>wx2421b1c4370ec43b</appid>
<bill_date>20141110</bill_date>
<bill_type>ALL</bill_type>
<mch_id>10000100</mch_id>
<nonce_str>21df7dc9cd8616b56919f20d9f679233</nonce_str>
<sign>332F17B766FC787203EBE9D6E40457A1</sign>
</xml>'
响应示例响应示例
{
"return_code": "string",
"return_msg": "string",
"error_code": "string"
}
请求参数
Body 参数application/xml
返回响应
修改于 2022-07-22 12:13:17