通用场景
根据商家pid和小程序id查询小程序对账订单列表信息,每页最多支持10条查询
公共请求参数
业务请求参数
mini_app_id|小程序应用id必选string[1,32]
【描述】小程序应用id
【示例值】2018110260384046
page_num|分页页码必选number[1,99999]
【描述】分页页码,从1开始
【示例值】1
page_size|分页大小必选number[1,10]
【描述】分页大小
【示例值】10
service_type_list|账单类型列表可选array[1,1000]
【描述】账单类型分类列表
【枚举值】
普通商品: physical_item
会员商品: member_item
【示例值】["physical_item","member_item"]
settlement_date|订单结算时间可选string[0,20]
【描述】订单结算日期,格式为yyyy-mm-dd
【示例值】2023-03-22
create_time|订单创建时间可选string[0,20]
【描述】订单创建日期,格式为yyyy-mm-dd
【示例值】2023-03-22
trade_no|支付宝交易号可选string[1,64]
【描述】支付宝交易号
【示例值】2013112011001004330000121536
order_status|订单状态可选string[1,20]
【描述】订单状态,传入此参数可查询指定状态的订单
【枚举值】
订单创建: init
等待支付: wait_pay
订单关闭: closed
【示例值】init
settle_status|结算状态可选string[1,20]
【描述】结算状态,传入此参数可查询指定结算状态的订单
【枚举值】
初始化: init
待结算: un_settle
已结算: settle
【示例值】un_settle
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.mini.order.itembill.batchquery&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"mini_app_id":"2018110260384046",
"service_type_list":[
"physical_item",
"member_item"
],
"settlement_date":"2023-03-22",
"create_time":"2023-03-22",
"trade_no":"2013112011001004330000121536",
"order_status":"init",
"settle_status":"un_settle",
"page_num":1,
"page_size":10
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
page_num|分页页码必选number(10)
【描述】分页页码
【示例值】1
page_size|分页大小必选number(10)
【描述】分页大小
【示例值】10
total|总数必选number(10)
【描述】总数
【示例值】100
order_list|订单对账列表可选itemorderbilldetailresponse[]
【描述】订单对账列表
service_type|二级场景类型必选string(64)
【描述】订单二级场景类型
【枚举值】
普通商品: physical_item
会员商品: member_item
【示例值】physical_item
mini_app_id|小程序应用id必选string(32)
【描述】订单关联小程序应用id
【示例值】2021004176600010
out_trade_no|商户订单号必选string(64)
【描述】商户订单号
【示例值】20230421111346
order_id|交易组件订单号必选string(128)
【描述】交易组件订单号
【示例值】2015042321001004720200028594
trade_no|支付宝交易号必选string(64)
【描述】支付宝交易号
【示例值】2013112011001004330000121536
order_name|订单名称必选string(1024)
【描述】订单名称
【示例值】订单xxx
create_time|订单创建时间必选date(32)
【描述】订单创建时间,格式为 yyyy-mm-dd hh:mm:ss
【示例值】2019-10-14 16:28:08
fee_categories|收费类目必选string(32)
【描述】支付宝公域会根据商家的具体成交场景和成交的商品类目来收取一定的技术服务费,技术服务费=结算基数*技术服务费费率,其中费率的部分由商品的类目来计算出。具体详情请查阅:
【示例值】餐饮
order_status|订单状态必选string(20)
【描述】订单状态
【示例值】paid
order_price|订单金额必选string(11)
【描述】订单总价,单位:元,精确到小数点后两位
【示例值】88.88
pre_promotion|支付前优惠金额必选string(11)
【描述】支付前优惠金额,单位:元,精确到小数点后两位
【示例值】10.00
pay_amount|支付金额必选string(11)
【描述】订单支付金额,单位:元,精确到小数点后两位
【示例值】88.88
receipt_amount|实收金额必选string(11)
【描述】订单实收金额,单位:元,精确到小数点后两位
【示例值】88.88
settle_status|结算状态必选string(10)
【描述】资金结算状态
【枚举值】
初始化: init
待结算: un_settle
已结算: settle
【示例值】un_settle
predict_settle_time|订单预计结算时间必选string(40)
【描述】订单预计结算时间,用户支付后确认收货前告知账期的天数, 表述为确认收货后x天结算;用户确认收货后,表述为预计时间格式为yyyy-mm-dd
【示例值】确认收货后7天结算
settle_time|结算时间必选date(32)
【描述】订单结算数据
【示例值】2023-05-23 17:09:28
settlement_amount|结算金额必选string(11)
【描述】订单结算金额,单位:元,精确到小数点后两位
【示例值】88.88
platform_service|cps技术服务费必选string(11)
【描述】cps技术服务费,单位:元,精确到小数点后两位
【示例值】1.00
refund_fee|退款金额必选string(11)
【描述】退款金额,单位:元,精确到小数点后两位
【示例值】88.88
platform_service_refund|退cps技术服务费必选string(11)
【描述】退cps技术服务费,单位:元,精确到小数点后两位
【示例值】0.50
sub_biz_no|平台子单号可选string(64)
【描述】平台子单号
【示例值】2024071801502300000005720092429611
pay_commission|支付手续费可选price(9)
【描述】支付手续费,单位:元,精确到小数点后两位
【示例值】10.00
huabei_technical_service_fee|花呗分期服务费可选price(9)
【描述】花呗分期服务费(卖家贴息),单位:元,精确到小数点后两位
【示例值】10.00
public_alloc_amount|达人佣金可选price(9)
【描述】达人佣金,单位:元,精确到小数点后两位
【示例值】10.00
public_name|达人昵称可选string(256)
【描述】达人昵称
【示例值】张三
isv_alloc_amount|服务商佣金可选price(9)
【描述】服务商佣金,单位:元,精确到小数点后两位
【示例值】10.00
isv_name|服务商名称可选string(256)
【描述】服务商名称
【示例值】xxx科技有限公司
rent_funder_commission_amount|租赁资方分账金额可选price(9)
【描述】资金提供方为租赁商提供货品采购资金,帮助租赁商扩大经营规模,因此资方收取部分佣金,单位:元,精确到小数点后两位。
【示例值】120.00
rent_funder_nick_name|租赁资方昵称可选string(256)
【描述】租赁资方昵称
【示例值】xxx有限公司
refund_fee_list|退款明细可选itemorderbillrefundresponse[]
【描述】退款明细列表
refund_type|订单退款类型必选string(10)
【描述】订单对账退款类型
【枚举值】
售中退款: un_settle
售后退款: settle
【示例值】settle
refund_fee|退款金额必选string(11)
【描述】退款金额,单位:元,精确到小数点后两位
【示例值】88.88
refund_pay_commission|退支付手续费可选price(9)
【描述】退支付手续费,单位:元,精确到小数点后两位
【示例值】10.00
refund_public_alloc_amount|退达人佣金可选price(9)
【描述】退达人佣金,单位:元,精确到小数点后两位
【示例值】10.00
refund_isv_alloc_amount|退服务商佣金可选price(9)
【描述】退服务商佣金,单位:元,精确到小数点后两位
【示例值】10.00
remark|备注可选string(2048)
【描述】备注
【示例值】备注信息
响应示例
正常示例
异常示例
{
"alipay_open_mini_order_itembill_batchquery_response": {
"code": "10000",
"msg": "success",
"page_num": 1,
"page_size": 10,
"total": 100,
"order_list": [
{
"service_type": "physical_item",
"mini_app_id": "2021004176600010",
"out_trade_no": "20230421111346",
"order_id": "2015042321001004720200028594",
"sub_biz_no": "2024071801502300000005720092429611",
"trade_no": "2013112011001004330000121536",
"order_name": "订单xxx",
"create_time": "2019-10-14 16:28:08",
"fee_categories": "餐饮",
"order_status": "paid",
"order_price": "88.88",
"pre_promotion": "10.00",
"pay_amount": "88.88",
"receipt_amount": "88.88",
"settle_status": "un_settle",
"predict_settle_time": "确认收货后7天结算",
"settle_time": "2023-05-23 17:09:28",
"settlement_amount": "88.88",
"platform_service": "1.00",
"pay_commission": "10.00",
"huabei_technical_service_fee": "10.00",
"public_alloc_amount": "10.00",
"public_name": "张三",
"isv_alloc_amount": "10.00",
"isv_name": "xxx科技有限公司",
"rent_funder_commission_amount": "120.00",
"rent_funder_nick_name": "xxx有限公司",
"refund_fee": "88.88",
"refund_fee_list": [
{
"refund_type": "settle",
"refund_fee": "88.88"
}
],
"platform_service_refund": "0.50",
"refund_pay_commission": "10.00",
"refund_public_alloc_amount": "10.00",
"refund_isv_alloc_amount": "10.00",
"remark": "备注信息"
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |