跳转至

支付单列表（分页）

功能说明

  • 查询支付单列表

接口地址

HTTP请求方式

  • Method: POST
  • Content-Type: application/x-www-form-urlencoded

参数说明

  • 公有参数

    发送请求是必须传入公共参数，详见公共参数

  • 私有参数

参数名称 是否必须 参数类型 长度限制 描述
enterprise_code 否 string [1,20] 企业编号（集团和运营商必填,企业不填）
time_start 否 string 开始时间，格式yyyy-MM-dd
time_end 否 string 结束时间，格式yyyy-MM-dd
contain_fee_trade 否 int 是否包含服务费记录. 1:是, 2:否 默认2
page_index 否 int 开始页数,默认1
page_size 否 int 显示行数,默认20，最大支持100条

请求示例（HTTP）

 POST /enterprise/consume/list HTTP/1.1
 Host: openapi.guanaitong.tech
 Content-Type: application/x-www-form-urlencoded
 Cache-Control: no-cache

access_token=e26026020539cd186f16ce041ac9cf6c&appid=20110661&sign=5347706e1cfba5d4ed6c041c0aa827897b173acc&version=1.0.0&timestamp=1660640879

请求示例（JAVA SDK）

public class Main {
    public static OpenClient openClient = new OpenClient(Constants.BASE_URL_TEST, "xxx", "xxx");
    public static void main(String[] args) {
        ConsumeListRequest consumeListRequest = new ConsumeListRequest();
        consumeListRequest.setTimeStart("2022-03-17");
        consumeListRequest.setTimeEnd("2022-03-17");
        consumeListRequest.setContainFeeTrade(2);
        consumeListRequest.setPageIndex(1);
        consumeListRequest.setPageSize(2);
        Pagination<ConsumeListResp> consumeListRespPagination = openClient.tradeApi().consumeList(consumeListRequest);
        System.out.println(JSON.toJSONString(consumeListRespPagination));
    }
}

返回参数说明

参数名称 描述
code 返回码。详见错误代码。
msg 如果错误，返回错误信息。
data 如果没有错误，返回支付单详情
data.trade_no String类型，关爱通的支付单号
data.out_trade_no String类型，关爱通的业务单号
data.userid String类型，支付人第三方唯一标识
data.payer_name String类型，支付人
data.subject String类型，商品描述或交易描述
data.total_amount BigDecimal类型，交易总金额
data.pay_amount BigDecimal类型，实际支付金额
data.refund_amount BigDecimal类型，退款金额
data.status Integer类型，交易状态。 1、待支付；2、支付中；3、支付完成； 4、待退款；5、退款中；6、退款；7、已冲正
data.create_time String类型，交易创建时间，格式yyyy-MM-dd HH:mm:ss
data.pay_time String类型，交易支付时间，格式yyyy-MM-dd HH:mm:ss
data.refund_time String类型，退款时间，格式yyyy-MM-dd HH:mm:ss
data.assetCode String类型，POINT 积分；QUOTA 额度；CASH 现金；THIRD 第三方资产

正确返回示例

{
    "total_count": 9,
    "data_list": [{
        "trade_no": "2022081620000398",
        "userid": "tom0001",
        "payer_name": "tom0001",
        "subject": "关爱商城订单（202208161897543596256528）",
        "total_amount": 1.00,
        "pay_amount": 1.00,
        "refund_amount": 0.00,
        "status": 3,
        "create_time": "2022-08-16 16:26:25",
        "pay_time": "2022-08-16 16:26:25",
        "asset_code": "POINT"
    }, {
        "trade_no": "2022070420000436",
        "userid": "tom0001",
        "payer_name": "tom0001",
        "subject": "关爱商城订单Z20220704000001",
        "total_amount": 500.00,
        "pay_amount": 500.00,
        "refund_amount": 0.00,
        "status": 3,
        "create_time": "2022-07-04 17:56:20",
        "pay_time": "2022-07-04 17:56:20",
        "asset_code": "POINT"
    }]
}

错误返回示例

{
    "code": 1000240002,
    "data": null,
    "msg": "enterprise_code校验失败"
}

常见错误码

错误码 错误信息
1000240002 enterprise_code校验失败
其他公共错误码 其他公共错误码
回到页面顶部