子商户交易汇总查询

最近更新时间:2019-09-27 15:39:29

接口描述

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

输入参数

参数名 必填 类型 说明
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。
device_id String 设备 ID。
qrcode_id String 二维码 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) 查询结束时间。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
out_trade_no String 订单号。
out_refund_no String 退款单号。
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_overview QueryOrderListOverviewResponse authen_info 存在时必填。详见 QueryOrderListOverviewResponse。

QueryOrderListOverviewResponse 结构

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

OrderStatClientInfo 结构

参数名 必填 类型 说明
out_sub_mch_id String 云支付分配的商户 ID。
out_shop_id String 云支付分配的门店 ID。
staff_id String 员工 ID。
device_id String 设备 ID。
qrcode_id String 二维码 ID。
source_type Number(32) 订单来源,1:一码付,2:店员户外二维码收银,3:绑定二维码,4:定额二维码,5:会员卡充值,6:临时二维码,7:会员卡一码付。
sub_pay_platform Number(32) 子支付平台列表,100:普通微信支付,200:普通支付宝,300:代金券/校园卡,401:银行卡记账,402:现金记账。
trade_type Number(32) 交易类型,1:刷卡支付,2:扫码支付,3:公众号支付,4:App 支付,5:声波支付, 6:H5 支付,8:一码付支付,9:小程序支付。
fee_type String 货币类型。
success_count Number(64) (交易量)不含撤单的,扣款成功交易笔数,有可能是负值。
success_amount Number(64) 不含撤单的,扣款成功交易金额,有可能是负值。
settle_amount Number(64) 操作人扣款成功结算金额 - 操作人退款结算金额 - 操作人扣款成功撤单结算金额。
discount_amount Number(64) net_amount - settle_amount。
pay_settle_amount Number(64) 扣款成功结算金额。
refund_settle_amount Number(64) 退款结算金额。
refund_create_count Number(64) 退款发起笔数。
refund_create_amount Number(64) 退款发起总额。
poundage Number(64) 扣款成功手续费 - 撤单返还手续费 - 退款成功返还的手续费,有可能是负值。
income_amount Number(64) 入账金额。
order_refunded_amount Number(64) 订单已退金额。
sub_mch_recharge_coupon_count Number(64) 必返回,商户充值优惠券数量。
sub_mch_recharge_coupon_amount Number(64) 必返回,商户充值优惠券金额。
platform_recharge_coupon_count Number(64) 必返回,平台充值优惠券数量。
platform_recharge_coupon_amount Number(64) 必返回,平台充值优惠券金额。
others_recharge_coupon_count Number(64) 必返回,其他充值优惠券数量。
others_recharge_coupon_amount Number(64) 必返回,其他充值优惠券金额。
sub_mch_non_recharge_coupon_count Number(64) 必返回,商户免充值优惠券数量。
sub_mch_non_recharge_coupon_amount Number(64) 必返回,商户免充值优惠券金额。
platform_non_recharge_coupon_count Number(64) 必返回,平台免充值优惠券数量。
platform_non_recharge_coupon_amount Number(64) 必返回,平台免充值优惠券金额。
others_non_recharge_coupon_count Number(64) 必返回,其他免充值优惠券数量。
others_non_recharge_coupon_amount Number(64) 必返回,其他免充值优惠券金额。
freeze_count Number(64) 必返回,冻结笔数。
freeze_amount Number(64) 必返回,冻结金额。
direct_unfreeze_count Number(64) 必返回,直接(调解冻接口)解冻笔数。
direct_unfreeze_amount Number(64) 必返回,直接(调解冻接口)解冻金额。
consumed_unfreeze_amount Number(64) 必返回,消费完成后自动解冻金额。
auto_unfreeze_amount Number(64) 必返回,冻结单创建成功30天后第三方支付平台自动解冻金额。

示例

输入参数示例:

{  
    "request_content": "{  
        "sub_pay_platforms":[100],  
        "out_sub_mch_id":"sz01F1Nq56FdmWj5vx25",  
        "out_shop_id":"sz01t2emx246y307BVon",  
        "staff_id":"178424",  
        "device_id":"61204",  
        "source_type":5,  
        "order_type":1,  
        "start_time":1567078099,  
        "end_time":1567083622,  
        "trade_type":1,  
        "pay_time_type":1,  
        "refund_time_type":1,  
        "time_filter":1  
    }",  
    "authen_info":{  
        "a":{  
            "authen_type":1,  
            "authen_code":"E05DB4F0E48798CF74369602EB090D0B1640E75F29BF375AB81BA0E6CF73E980"  
        }  
    }  
} 

输出参数示例:

{  
    "response_content": "{  
        "status":0,  
        "description":"u64CDu4F5Cu6210u529Fu3002",  
        "log_id":761035717,  
        "Internal_status":0,  
        "query_order_list_overview":{  
            "overviews":[  
                {  
                    "fee_type":"CNY",  
                    "success_count":415,  
                    "success_amount":743380,  
                    "settle_amount":743380,  
                    "discount_amount":0,  
                    "pay_settle_amount":743380,  
                    "refund_settle_amount":0,  
                    "refund_create_count":0,  
                    "refund_create_amount":0,  
                    "poundage":2341,  
                    "income_amount":741039,  
                    "order_refunded_amount":0,  
                    "sub_mch_recharge_coupon_count":3,  
                    "sub_mch_recharge_coupon_amount":20,  
                    "platform_recharge_coupon_count":0,  
                    "platform_recharge_coupon_amount":0,  
                    "others_recharge_coupon_count":0,  
                    "others_recharge_coupon_amount":0,  
                    "sub_mch_non_recharge_coupon_count":0,  
                    "sub_mch_non_recharge_coupon_amount":0,  
                    "platform_non_recharge_coupon_count":0,  
                    "platform_non_recharge_coupon_amount":0,  
                    "others_non_recharge_coupon_count":0,  
                    "others_non_recharge_coupon_amount":0,  
                    "freeze_count":0,  
                    "freeze_amount":0,  
                    "direct_unfreeze_count":0,  
                    "direct_unfreeze_amount":0,  
                    "consumed_unfreeze_amount":0,  
                    "auto_unfreeze_amount":0  
                }  
            ],  
            "nonce_str":"KdGI3KZabkasaTQITNsSIyvFI7S86No4"  
        }  
    }",  
    "authen_info":{  
        "a":{  
            "authen_type":1,  
            "authen_code":"66FCA9C535D2E166FC103731859BA7C9298A580BCD8A87F9869461689A39F4AA"  
            }  
        }  
    }  
}