多条件查询订单信息

最近更新时间:2019-09-12 15:42:39

接口描述

url https://pay.qcloud.com/cpay/query_order_list

输入参数

参数名 必填 类型 说明
request_content String 请求内容,该 string 可以转为 json 结构,json 格式见本节 RequestContent。
authen_info AuthenInfo 认证信息,详见接口调用说明。

RequestContent 结构

参数名 必填 类型 说明
sub_pay_platforms Number(32)[] 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
out_sub_mch_id String 云支付分配的商户 ID。
out_shop_id String 云支付分配的门店 ID。
staff_id String 员工 ID,如果设置,则必须同时设置 out_shop_id。
device_id String 设备 ID,如果设置,则必须同时设置 out_shop_id。
qrcode_id String 二维码 ID,如果设置,则必须同时设置 out_shop_id。
source_type Number(32) 订单来源,1:一码付,2:店员户外二维码收银,3:绑定二维码,4:定额二维码,5:会员卡充值,6:临时二维码,7:会员卡一码付。
order_type Number(32) 单据类型,1:支付订单,2:退款单,3:全部单据,4:冻结单,5:解冻单。
start_time Number(64) 查询开始时间。
end_time Number(64) 查询结束时间。
page_num Number(32) 页码。
page_size Number(32) 单页条数。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
pay_time_type Number(32) 支付时间类型,1:支付单创建时间,2:支付单成功时间, 默认为2。
refund_time_type Number(32) 退款时间类型,1:退款创建时间, 2:退款发起时间, 默认为2。
time_filter Number(32) 时间过滤字段,1:创建时间,2:更新时间, 默认为2。
status Number(32) 查出处于该状态的单,0:只查询成功状态的单,1:查询所有状态的单,默认为0。
nonce_str String 随机字符串。

输出参数

参数名 必填 类型 说明
response_content ResponseContent 请求内容,详见本节 ResponseContent。
authen_info AuthenInfo 认证信息,详见接口调用说明。

ResponseContent 结构

参数名 必填 类型 说明
status Status 错误码,详见 Status。0:成功;非0:失败或者需要重试,具体见实际返回的错误码。
description String(255) 错误描述。
log_id Number(32) 消息 ID。
Internal_status Number(32) 调试使用,调用者可以不予理会。
query_order_list QueryOrderListResponse authen_info 存在时必填。详见 QueryOrderListResponse。

QueryOrderListResponse 结构

参数名 必填 类型 说明
nonce_str String(32) 随机字符串。
total_count Number(32) 汇总数。
order_details OrderDetail[] 交易明细结构体。

OrderDetail 结构

参数名 必填 类型 说明
order[1] Order 订单结构体,见本节 Order。
refund_order[1] RefundOrder 退款单结构体, 见本节 RefundOrder。
freeze_order[1] FreezeOrder 冻结单结构体,见本节 FreezeOrder。
unfreeze_order[1] UnfreezeOrder 解冻单结构体, 见本节 UnfreezeOrder。

[1]: order、refund_order、freeze_order 和 unfreeze_order 只能包含一个。

Order 结构

参数名 必填 类型 说明
out_mch_id String 云支付分配给服务商的 ID。
out_sub_mch_id String 云支付分配给子商户的 ID。
shop_name String 门店名称。
staff_id String 店员 ID。
staff_name String 店员姓名。
device_id String 设备 ID。
device_name String 设备名称。
qrcode_id String 二维码 ID。
qrcode_name String 二维码名称。
source_type Number(32) 订单来源,1:一码付,2:店员户外二维码收银,3:绑定二维码,4:定额二维码,5:会员卡充值,6:临时二维码,7:会员卡一码付。
out_card_id String 会员卡 ID。
sub_pay_platform Number(32) 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
out_trade_no String 子商户订单号,云支付系统单 Set 内全局唯一。
transaction_id String 第三方支付平台的订单号。
total_fee Number(64) 订单总金额。
fee_type String 货币类型。
cash_fee Number(64) 现金支付金额。
cash_fee_type String 现金支付货币类型。
settlement_total_fee Number(64) 应结支付金额。
discount_fee Number(64) 优惠金额。
recharge_bonus_fee Number(64) 会员卡充值赠送金额。
is_card_recharge Bool 是否会员卡充值单。
poundage Number(64) 第三方账单给出的手续费。
coupon_infos CouponInfo 优惠信息,见公共结构体 CouponInfo。
remaining_settlement_fee Number(64) 订单实收金额。
income_fee Number(64) 入账金额。
time_end Number(64) 支付完成时间。
create_time Number(64) 订单创建时间。
last_update_time Number(64) 订单最近更新时间。
body String 商品或订单简要描述,下单时必填。
detail String 商品详细列表。
client_flow_id String 客户端流水单号。
remark String 支付备注信息。
refunded_fee Number(64) 已退金额。
refund_create_time Number(64) 最近退款创建时间。
refund_time Number(64) 最近退款成功时间。
refunded_settlement_fee Number(64) 已退结算金额。
wxpay_current_trade_state Number(32) 微信订单状态,见枚举值定义 WxpayOrderState。
attach String 附加数据,记录子商户自定义数据。
bank_type String 刷卡支付时特有,付款银行类型,遵守字符型银行编码规范。
goods_tag String 商品标记,代金券或立减优惠功能的参数。
scene_info String 支付的场景信息 json 串。
alipay_current_trade_state Number(32) 支付宝订单状态,见枚举值定义 AlipayOrderState。
discountable_amount Number(64) 参与优惠的金额。
undiscountable_amount Number(64) 不参与优惠的金额。
membership_number String 会员卡号。
uid Number(64) 会员 uid。
credits Number(64) 实际消费的积分数量。
record_current_trade_state Number(32) 记账订单状态,见枚举值定义 RecordOrderState。
out_freeze_no String 预授权号。
freeze_fee Number(64) 冻结金额。
is_deposit_mode Bool 押金下模式。
is_confirm_unfreeze Bool 是否在消费并且解冻用户金额。
manual_unfreeze_fee Number(64) 消费且解冻金额。
freeze_id String 冻结单 freeze_id。

RefundOrder 结构

参数名 必填 类型 说明
out_mch_id String 云支付分配给服务商的 ID。
out_sub_mch_id String 云支付分配给子商户的 ID。
out_shop_id String 云支付分配给门店的 ID。
shop_name String 门店名称。
staff_id String 店员 ID。
staff_name String 店员姓名。
device_id String 设备 ID。
device_name String 设备名称。
qrcode_id String 二维码 ID。
qrcode_name String 二维码名称。
source_type Number(32) 订单来源,1:一码付,2:店员户外二维码收银,3:绑定二维码,4:定额二维码,5:会员卡充值,6:临时二维码,7:会员卡一码付。
out_card_id String 会员卡 ID。
sub_pay_platform Number(32) 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
out_trade_no String 子商户订单号,云支付系统单 Set 内全局唯一。
total_fee Number(64) 订单总金额。
out_refund_no String 子商户退款单号,云支付系统单 Set 内全局唯一。
refund_id String 第三方支付平台的退款单号。
refund_fee Number(64) 本次退款总金额。
settlement_refund_fee Number(64) 本次退款结算金额。
refund_fee_type String 本次退款总金额货币类型。
poundage Number(64) 第三方账单给出的手续费。
coupon_infos CouponInfo 退款优惠信息,见公共结构体 CouponInfo。
income_fee Number(64) 入账金额。
create_time Number(64) 退款单创建时间。
last_update_time Number(64) 退款单最近更新时间。
refund_start_processing_time Number(64) 退款发起时间。
pay_last_update_time Number(64) 支付成功时间。
refund_reason String 退款原因。
client_refund_flow_id String 客户端退款流水单号。
wxpay_refund_state Number(32) 微信退款状态,见枚举值定义 WxpayRefundOrderState。
cash_refund_fee Number(64) 现金退款金额。
cash_refund_fee_type String 现金退款货币类型。
alipay_refund_state Number(32) 支付宝退款状态,见枚举值定义 AlipayRefundOrderState。
credits Number(64) 实际退款的积分数量。
record_refund_state Number(32) 记账退款状态,见枚举值定义 RecordRefundOrderState。
is_deposit_mode bool 押金下模式。
out_freeze_no String 外部授权单号(押金消费退款必填)。
freeze_fee Number(64) 冻结金额。

FreezeOrder 结构

参数名 必填 类型 说明
out_mch_id String 云支付分配给服务商的 ID。
out_sub_mch_id String 云支付分配给子商户的 ID。
out_shop_id String 云支付分配给门店的 ID。
shop_name String 门店名称。
staff_id String 店员 ID。
staff_name String 店员姓名。
device_id String 设备 ID。
device_name String 设备名称。
sub_pay_platform Number(32) 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
out_freeze_no String 授权订单号。
freeze_id String 第三方授权单号。
freeze_fee Number(64) 冻结金额。
fee_type String 货币类型。
cash_fee Number(64) 现金支付金额。
cash_fee_type String 现金支付货币类型。
settlement_total_fee Number(64) 应结支付金额。
discount_fee Number(64) 针对商户来说的优惠金额:total_fee - settlement_total_fee。
total_consume_fee Number(64) 总消费金额。
total_manual_unfreeze_fee Number(64) 总解冻金额。
total_auto_unfreeze_fee Number(64) 自动30天后自动的解冻金额。
total_refund_fee Number(64) 总退款金额。
coupon_infos CouponInfo 优惠信息(第三方平台返回),见公共结构体 CouponInfo。
create_time Number(64) 订单创建时间。
last_update_time Number(64) 订单最近更新时间。
time_end Number(64) 支付完成时间(第三方返回)。
body String 商品或订单简要描述,外部必填参数。
detail String 优惠信息。
exchange_rate Number(64) 汇率。
remark String 支付备注信息。
wxpay_current_trade_state Number(32) 微信冻结单状态,见枚举值定义 WxpayFreezeOrderState。
alipay_current_trade_state Number(32) 支付宝冻结单状态,见枚举值定义 AlipayFreezeOrderState。

UnfreezeOrder 结构

参数名 必填 类型 说明
out_mch_id String 云支付分配给服务商的 ID。
out_sub_mch_id String 云支付分配给子商户的 ID。
out_shop_id String 云支付分配给门店的 ID。
shop_name String 门店名称。
staff_id String 店员 ID。
staff_name String 店员姓名。
device_id String 设备 ID。
device_name String 设备名称。
sub_pay_platform Number(32) 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
out_freeze_no String 授权订单号。
out_unfreeze_no String 解冻单号。
unfreeze_id String 第三方操作单号。
freeze_id String 对应冻结单中 freeze_id。
unfreeze_fee Number(64) 解冻金额。
fee_type String 货币类型。
time_end Number(64) 解冻完成时间。
create_time Number(64) 订单创建时间。
last_update_time Number(64) 订单最近更新时间。
remark String 备注信息。
wxpay_current_trade_state Number(32) 微信解冻单状态,见枚举值定义 WxpayUnfreezeOrderState。
alipay_current_trade_state Number(32) 支付宝解冻单状态,见枚举值定义 AlipayUnfreezeOrderState。

示例

输入参数示例:

{  
    "request_content": "{  
        "sub_pay_platforms":[],  
        "order_type":3,  
        "start_time":1567008000,  
        "end_time":1567094399,  
        "page_num":1,  
        "page_size":2,  
        "status":1,  
        "device_id":"63372",  
        "out_shop_id":"sz015qVUJ0c41KDyiArL",  
        "out_sub_mch_id":"sz01O2GIKS3e8Y9tjlM0",  
        "trade_type":1  
    }",  
    "authen_info":{  
        "a":{  
            "authen_type":1,  
            "authen_code":"A761AF25039DC5C4163148ADBAE008DB1D97F42D1E04E739D4821A3B1AE89319"  
        }  
    }  
}  

输出参数示例:

{  
    "response_content": "{  
        "status":0,  
        "description":" \u64cd\u4f5c\u6210\u529f\u3002",  
        "log_id":2043799495,  
        "Internal_status":0,  
        "query_order_list":{  
            "total_count":51,  
            "order_details":[  
                {  
                    "order":{  
                        "out_mch_id":"sz01GXOqB5dNbUIOWMoR",  
                        "out_sub_mch_id":"sz01O2GIKS3e8Y9tjlM0",  
                        "out_shop_id":"sz015qVUJ0c41KDyiArL",  
                        "shop_name":" \u0078\u0078\u0078\u5e97",  
                        "staff_id":"833",  
                        "staff_name":" \u5c0f\u5b9d",  
                        "device_id":"63372",  
                        "device_name":" \u6536\u94f6\u53f0\u4e00",  
                        "qrcode_id":"",  
                        "qrcode_name":"",  
                        "source_type":0,  
                        "sub_pay_platform":100,  
                        "trade_type":1,  
                        "out_trade_no":"0103260006050213462",  
                        "transaction_id":"4200000374201908293900269343",  
                        "total_fee":180000,  
                        "fee_type":"CNY",  
                        "cash_fee":180000,  
                        "cash_fee_type":"CNY",  
                        "settlement_total_fee":180000,  
                        "discount_fee":0,  
                        "recharge_bonus_fee":0,  
                        "is_card_recharge":false,  
                        "remaining_settlement_fee":180000,  
                        "time_end":1567074507,  
                        "create_time":1567074500,  
                        "last_update_time":1567074508,  
                        "body":"\u0078\u0078\u0078\u5e97\u0028\u8bbe\u5907\u6536\u8d39\u0029",  
                        "detail":"",  
                        "client_flow_id":"",  
                        "remark":"",  
                        "refunded_fee":0,  
                        "refund_create_time":0,  
                        "refund_time":0,  
                        "refunded_settlement_fee":0,  
                        "wxpay_current_trade_state":2,  
                        "attach":"",  
                        "bank_type":"CFT",  
                        "goods_tag":"",  
                        "scene_info":"",  
                        "is_deposit_mode":false  
                    }  
                },  
                {  
                    "refund_order":{  
                        "out_mch_id":"sz01GXOqB5dNbUIOWMoR",  
                        "out_sub_mch_id":"sz01O2GIKS3e8Y9tjlM0",  
                        "out_shop_id":"sz015qVUJ0c41KDyiArL",  
                        "shop_name":" \u0078\u0078\u0078\u5e97",  
                        "staff_id":"833",  
                        "staff_name":" \u5927\u5b9d",  
                        "device_id":"63372",  
                        "device_name":" \u6536\u94f6\u53f0\u4e8c",  
                        "qrcode_id":"",  
                        "source_type":0,  
                        "sub_pay_platform":200,  
                        "trade_type":1,  
                        "out_trade_no":"0103260006050213757",  
                        "total_fee":250000,  
                        "out_refund_no":"0103260006051213250",  
                        "refund_id":"",  
                        "refund_fee":250000,  
                        "settlement_refund_fee":250000,  
                        "refund_fee_type":"CNY",  
                        "create_time":1567069546,  
                        "last_update_time":1567069547,  
                        "refund_start_processing_time":1567069546,  
                        "pay_last_update_time":1567067344,  
                        "refund_reason":"\u8ba2\u5355\u5e9f\u5f03\u9000\u6b3e", 
                        "client_refund_flow_id":"",  
                        "alipay_refund_state":2,  
                        "is_deposit_mode":false  
                    }  
                }  
            ],  
            "nonce_str":"wt6SdiH2oEEFM74fKp04Go9WFx0aeVOq"  
        }  
    }",  
    "authen_info":{  
        "a":{  
            "authen_type":1,  
            "authen_code":"265EB59F76376F6AA59973E0EF922A89976D704A9DECFDE026BD73593BB4B96C"  
        }  
    }  
}