获取收款订单列表 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

第三方应用开发

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

第三方应用开发服务端API 收银台收款工具获取收款订单列表

获取收款订单列表

最后更新：2023/06/07

服务商可以使用该接口查询指定时间段内创建的各种业务的收款订单列表

请求方式:POST(HTTPS)

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

请求示例

{
    "business_type":1,
    "start_time":1670643437,
    "end_time":1671507437,
    "cursor":"tJzlB9tdqfh-g7i_J-ehOz_TWcd7dSKa39_AqCIeMFw",
    "limit":0,
    "nonce_str":"129031823",
    "ts":1548302135,
    "sig":"mPOwVW/vQ74xN+b+Yu1KMa9RrmhKJaJjAtXHTof+EpU="
}

参数说明:

参数	必须	类型	说明
provider_access_token	是	string	服务商调用接口凭证
business_type	否	uint32	业务类型取值范围： 1 - 普通第三方应用 2 - 代开发应用 3 - 行业解决方案
start_time	否	uint32	起始时间
end_time	否	uint32	结束时间
cursor	否	string	用于分页查询的游标，字符串类型，由上一次调用返回，首次调用不填
limit	是	uint32	分页，预期请求的数据量，取值范围 1 ~ 2000
nonce_str	是	string	随机字符串，长度要求在32字节以内，用于保证签名不可预测及防重放攻击。需保证15分钟内不能重复，推荐随机字符串生成算法
ts	是	uint64	unix时间戳（中国时区）,精确到秒。注意业务系统的机器时间与腾讯的时间相差不能超过15分钟
sig	是	string	数字签名。见签名算法。签名所需密钥获取路径：工作台->企业微信服务商助手->工具->收银台->收银台API调用密钥

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

返回结果:

{
    "errcode": 0, 
    "errmsg": "ok", 
    "next_cursor": "5f0uN2RNNsR8Dj0G08XUSg==", 
    "has_more": 1, 
    "pay_order_list": [
        {
            "order_id": "ORDERID", 
            "create_time": 1672220217, 
            "custom_corpid": "wx9***********65f9", 
            "buy_content": "BUYCONTENT", 
            "origin_price": 1000, 
            "paid_price": 9000, 
            "order_status": 1, 
            "order_from": 1, 
            "creator": "CREATOR",
            "pay_type" : 2
        }
    ]
}

参数说明:

参数	类型	说明
errcode	int32	返回码
errmsg	string	错误码描述
next_cursor	string	分页游标，下次请求时填写以获取之后分页的记录
has_more	uint32	是否还有更多数据
pay_order_list	obj[]	订单列表
pay_order_list.order_id	string	订单号
pay_order_list.create_time	uint64	订单创建时间
pay_order_list.custom_corpid	string	客户企业的corpid
pay_order_list.buy_content	string	购买内容
pay_order_list.origin_price	uint64	原价金额
pay_order_list.paid_price	uint64	实付金额。免支付订单实付金额返回0
pay_order_list.order_status	uint32	订单状态。取值范围为： 1 - 待支付 2 - 已支付 3 - 订单取消 4 - 支付过期 5 - 退款申请中 6 - 已退款 7 - 交易完成 8 - 待企业确认 9 - 已部分退款
pay_order_list.order_from	uint32	订单来源。取值范围为： 1 - 客户下单 2 - 服务商创建
pay_order_list.creator	string	订单创建人
pay_order_list.pay_type	uint32	支付方式 0-客户支付；1-服务商代支付；2-免支付

取消收款订单

获取收款订单详情

本节内容

获取收款订单列表