获取收款订单详情 - 文档 - 企业微信开发者中心

服务商代开发

快速入门服务端API 客户端API 附录更新日志联系我们

服务商代开发

服务端API

收银台

收款工具

获取收款订单详情

最后更新：2023/10/25

服务商可以使用该接口查询指定收款订单的详情

请求方式:POST(HTTPS)

请求地址: https://qyapi.weixin.qq.com/cgi-bin/paytool/get_order_detail?provider_access_token=PROVIDER_ACCESS_TOKEN

请求示例

{
  "order_id": "T0Rkc2g3dWlQNzFLNTRXMDJBV25BNi95OVZZbjBPOE11N2FCWkc0STJRdz0=",
  "nonce_str": "129031823",
  "ts": 1548302135,
  "sig": "mPOwVW/vQ74xN+b+Yu1KMa9RrmhKJaJjAtXHTof+EpU="
}

参数说明:

参数	必须	类型	说明
provider_access_token	是	string	服务商调用接口凭证
order_id	是	string	订单号
nonce_str	是	string	随机字符串，长度要求在32字节以内，用于保证签名不可预测及防重放攻击。需保证15分钟内不能重复，推荐随机字符串生成算法
ts	是	uint64	unix时间戳（中国时区）,精确到秒。注意业务系统的机器时间与腾讯的时间相差不能超过15分钟
sig	是	string	数字签名。见签名算法。签名所需密钥获取路径：工作台->企业微信服务商助手->工具->收银台->收银台API调用密钥

权限说明: (无特殊权限)

返回结果:

{
  "errcode": 0,
  "errmsg": "ok",
  "pay_order": {
    "order_id": "ORDERID",
    "create_time": 1671161338,
    "custom_corpid": "ww0***********7e21",
    "buy_content": "BUYCONTENT",
    "origin_price": 10000,
    "paid_price": 9000,
    "order_status": 2,
    "order_from": 1,
    "creator": "CREATOR",
    "pay_type": 1,
    "custom_corp_name": "测试企业",
    "pay_channel": 1,
    "channel_order_id": "4200001711202212169932901772",
    "paid_time": 1671161378,
    "business_type": 2,
    "income_type": 1,
    "income_time": 1672111778,
    "income_amount": 2,
    "product_list": {
      ......
    }
  }
}

不同业务类型（business_type），返回的商品详情（product_list）不同
普通第三方应用：

{
    "third_app": {
        "order_type": 0, 
        "buy_info_list": [
            {
                "suiteid": "SUITEID", 
                "appid": 1, 
                "edition_id": "版本名字", 
                "user_count": 10, 
                "duration_days": 365, 
                "origin_price": 10000, 
                "paid_price": 9000,
                "take_effect_date": "20221220"
            }
        ]
    }
}

代开发应用：

{
    "customized_app": {
        "order_type": 2, 
        "buy_info_list": [
            {
                "suiteid": "SUITEID", 
                "user_count": 10, 
                "duration_days": 365, 
                "origin_price": 10000, 
                "paid_price": 9000, 
                "take_effect_date": "20221220"
            }
        ]
    }
}

行业解决方案:

{
    "promotion_case": {
        "order_type": 0, 
        "case_id": "CASEID", 
        "promotion_edition_name": "版本名字", 
        "buy_info_list": [
            {
                "suiteid": "SUITEID", 
                "appid": 1, 
                "user_count": 10, 
                "take_effect_date": "20221220"
            }
        ]
    }
}

参数说明:

参数	类型	说明
errcode	int32	返回码
errmsg	string	错误码描述
pay_order	obj	订单详情
pay_order.order_id	string	订单号
pay_order.create_time	uint64	订单创建时间
pay_order.custom_corpid	string	客户企业的corpid
pay_order.buy_content	string	购买内容
pay_order.origin_price	uint64	原价金额
pay_order.paid_price	uint64	实付金额。免支付订单实付金额返回0
pay_order.order_status	uint32	订单状态。取值范围为： 1 - 待支付 2 - 已支付 3 - 订单取消 4 - 支付过期 5 - 退款申请中 6 - 已退款 7 - 交易完成 8 - 待企业确认 9 - 已部分退款
pay_order.pay_from	uint32	支付方式 0-客户支付；1-服务商代支付；2-免支付
pay_order.order_from	uint32	订单来源。取值范围为： 1 - 客户下单 2 - 服务商创建
pay_order.creator	uint64	订单创建人
pay_order.pay_type	uint32	支付方式 0-客户支付；1-服务商代支付；2-免支付
pay_order.custom_corp_name	string	客户企业简称
pay_order.pay_channel	uint32	付款方式。取值范围为： 1 - 微信支付 2 - 网银支付如果未支付该字段为空
pay_order.channel_order_id	string	付款流水号，如果未支付该字段为空
pay_order.paid_time	uint64	付款时间，如果未支付该字段为空
pay_order.business_type	uint32	业务类型。取值范围： 1 - 普通第三方应用 2 - 代开发应用 3 - 行业解决方案
pay_order.income_type	uint32	收入到账商户号。取值范围： 1 - 微信支付商户号 2 - 财付通商户号如果收入未到账该字段为空
pay_order.income_time	uint64	到账时间，如果收入未到账该字段为空
pay_order.income_amount	uint32	到账金额，如果收入未到账该字段为空
pay_order.product_list	obj	购买明细，不同业务类型的明细不一样
pay_order.product_list.third_app	obj	普通第三方应用的购买明细
pay_order.product_list.third_app.order_type	uint32	订单类型取值范围： 0 - 新购 1 - 扩容 2 - 续期
pay_order.product_list.third_app.buy_info_list	obj[]	购买应用列表可填充个数： 1 ~ 20
pay_order.product_list.third_app.buy_info_list.suiteid	string	套件ID 不多于64字节
pay_order.product_list.third_app.buy_info_list.appid	uint32	应用ID（仅旧套件应用需要填）
pay_order.product_list.third_app.buy_info_list.edition_id	string	版本号ID 不多于64字节
pay_order.product_list.third_app.buy_info_list.user_count	uint32	应用的购买人数，单位人当购买类型是新购或扩容时需要填注意对于扩容类型，表示增加的人数取值范围：1 ~ 1000000
pay_order.product_list.third_app.buy_info_list.duration_days	uint32	应用的购买时长，单位天取值范围：1 ~ 1825
pay_order.product_list.third_app.buy_info_list.origin_price	uint32	原价金额
pay_order.product_list.third_app.buy_info_list.paid_price	uint32	实付金额
pay_order.product_list.third_app.buy_info_list.take_effect_date	string	生效日期，格式如：20221212
pay_order.product_list.customized_app	obj	代开发应用购买详情
pay_order.product_list.customized_app.order_type	uint32	购买类型取值范围： 0 - 新购 1 - 扩容 2 - 续期
pay_order.product_list.customized_app.buy_info_list	obj[]	购买应用列表可填充个数： 1 ~ 20
pay_order.product_list.customized_app.buy_info_list.suiteid	string	套件ID 不多于64字节
pay_order.product_list.customized_app.buy_info_list.user_count	uint32	应用的购买人数，单位人当购买类型是新购或扩容时需要填注意对于扩容类型，表示增加的人数取值范围：1 ~ 1000000
pay_order.product_list.customized_app.buy_info_list.duration_days	uint32	应用的购买时长，单位天取值范围：1 ~ 1825
pay_order.product_list.customized_app.buy_info_list.origin_price	uint32	原价金额
pay_order.product_list.customized_app.buy_info_list.paid_price	uint32	实付金额
pay_order.product_list.customized_app.buy_info_list.take_effect_date	string	生效日期，格式如：20221212
pay_order.product_list.promotion_case	obj	行业解决方案购买详情当业务类型是"行业解决方案"时必填
pay_order.product_list.promotion_case.order_type	uint32	购买类型取值范围： 0 - 新购 1 - 扩容 2 - 续期
pay_order.product_list.promotion_case.case_id	string	行业方案ID 不多于64字节
pay_order.product_list.promotion_case.promotion_edition_name	string	行业方案版本名不多于64字节
pay_order.product_list.promotion_case.duration_days	uint32	应用的购买时长，单位天取值范围：1 ~ 1825
pay_order.product_list.promotion_case.buy_info_list	obj[]	购买应用列表可填充个数： 1 ~ 20
pay_order.product_list.promotion_case.buy_info_list.suiteid	string	套件ID 不多于64字节
pay_order.product_list.promotion_case.buy_info_list.appid	uint32	应用ID（仅旧套件应用需要填）
pay_order.product_list.promotion_case.buy_info_list.user_count	uint32	应用的购买人数，单位人当购买类型是新购或扩容时需要填注意对于扩容类型，表示增加的人数取值范围：1 ~ 1000000
pay_order.product_list.promotion_case.buy_info_list.take_effect_date	string	生效日期，格式如：20221212