猫酷开放平台

# 智能收单

# 生成订单接口

TIP

用于从猫酷系统生成并获取订单号

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Order/Add (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
DevShopID string 是 第三方商户号
PosID string 是 终端号（POS机号）
MallCardNo string 否 会员卡号
PosOrderID string 是 外部订单号
CashierID string 是 收银员编号
Amount int 是 订单金额（单位：分）

# 调用示例


{
  "DevShopID": "PD201705050",
  "PosID": "PL201705050",
  "MallCardNo": "FG201705050",
  "PosOrderID": "VC201705050",
  "CashierID": "QS201705050",
  "Amount":20
}
1
2
3
4
5
6
7
8
9
10

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
OrderID string 否 订单号
CreatedTime string 是 生成时间
# 返回示例

{
  "Code":1,
  "Data":{
      "OrderID":"KG2001001010",
      "CreatedTime":"2017-11-11 11:11:11"
  },
  "Message":null
}
1
2
3
4
5
6
7
8
9
10



# 同步订单信息接口

TIP

同步订单的使用券信息、优惠金额和待支付金额

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Order/Sync (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
OrderID string 是 订单号
TotalDiscount int 是 优惠金额（单位：分）
CouponList List<Coupon> 否 使用券列表
PayableAmount int 是 应付金额（单位：分）
# Coupon
名称 数据类型 必填 说明
VCode string 是 券码
Discount int 是 券抵扣金额（单位：分）

# 调用示例


{
  "OrderID": "PD201705050",
  "TotalDiscount": 1000,
  "CouponList":
   [
      {
        "VCode":"GF2000",
        "Discount":10000
      },
      {
        "VCode":"GF2000",
        "Discount":10000
      }
   ],

  "PayableAmount":150
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
  "Code":1,
  "Message":"操作成功！"
}
1
2
3
4
5
6



# 支付结果通知

TIP

同步订单的支付信息

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Order/Inform (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
OrderID string 是 订单号
PaymentAmount int 是 实际支付金额（单位：分）
PayTime string 是 支付时间
TradeSerialNo string 是 支付流水号
PayType int 是 交易类型1.银行卡 2.现金 3.扫码支付（收款码）4.扫码支付（扫一扫）
PayMethod int 否 支付渠道1.支付宝 2.微信支付 3.拉卡拉钱包4.百度钱包 5.京东钱包 6.银联钱包 7.会员付 8.预付卡

# 调用示例


{
  "OrderID": "PD201705050",
  "PaymentAmount": 2,
  "PayTime": "2017-05-05 23:20:20",
  "TradeSerialNo": "VC201705050",
  "PayType": 2,
  "PayMethod":1
}
1
2
3
4
5
6
7
8
9
10

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
  "Code":1,
  "Message":"操作成功"
}
1
2
3
4
5
6



# 订单查询

TIP

根据条件查询商户订单

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Order/Records (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
OrderID string 否 订单号
SearchStartTime string 否 订单生成起始时间
SearchEndTime string 否 订单生成结束时间
PayStartTime string 否 支付起始时间
PayEndTime string 否 支付结束时间
PayMethod int 否 支付方式
TradeSerialNo string 否 交易流水号
DevShopID string 二选一 商户号
PosID string 二选一 终端号（POS机号）
Status int 否 订单状态
MinID string 是 最小ID
PageSize int 是 每页条数
PayType int 否 交易类型1.银行卡 2.现金 3.扫码支付（收款码）4.扫码支付（扫一扫）

# 调用示例


{
    
    "PosID": "456", 
    "PageSize": 2
}
1
2
3
4
5
6

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
OrderInfoList List<OrderInfoModel> 是 返回状态
Count int 是 总数
# OrderInfoModel
名称 数据类型 必填 说明
Amount int 是 订单金额
CashierID string 是 收银员
CouponList List<Coupon> 是 优惠券信息
CreatTime string 是 创建时间
DevShopID string 是 商户号
MallCardNo string 是 会员卡号
OrderID string 是 订单号
PayableAmount int 是 应付金额
PaymentAmount int 是 支付金额
PayMethod int 是 支付渠道1.支付宝 2.微信支付 3.拉卡拉钱包4.百度钱包 5.京东钱包 6.银联钱包 7.会员付 8.预付卡
PayTime string 是 支付时间
PayType int 是 交易类型1.银行卡 2.现金 3.扫码支付（收款码）4.扫码支付（扫一扫）
PosOrderID string 是 外部订单号
PostId string 是 终端号
Status int 是 支付状态
TotalDiscount int 是 总优惠金额
TradeSerialNo string 是 交易流水号
# Coupon
名称 数据类型 必填 说明
VCode string 是 券码
Discount int 是 券抵扣金额（单位：分）
# 返回示例

{
    "Code": 1, 
    "Data": {
        "Count": 12, 
        "OrderInfoList": [
            {
                "Amount": 100, 
                "CashierID": "03", 
                "CouponList": [
                     {
                       "VCode": "20001010", 
                       "DiscountAmount": 3
                     }, 
                     {
                      "VCode": "20001010", 
                      "DiscountAmount": 500
                     }
                  ], 
                "CreatTime": "2017/11/13 16:58:23", 
                "DevShopID": "9998", 
                "MallCardNo": null, 
                "OrderID": "PO201711131658233016361", 
                "PayableAmount": 0, 
                "PaymentAmount": 0, 
                "PayMethod": 0, 
                "PayTime": "0001/01/01 00:00:00", 
                "PayType": 0, 
                "PosOrderID": "2148", 
                "PostID": "456", 
                "Status": 1, 
                "TotalDiscount": 0, 
                "TradeSerialNo": null
            }, 
            {
                "Amount": 100, 
                "CashierID": "03", 
                "CouponList": [
                     {
                       "VCode": "20001010", 
                       "DiscountAmount": 3
                     }, 
                     {
                      "VCode": "20001010", 
                      "DiscountAmount": 500
                     }
                  ], 
                "CreatTime": "2017/11/13 16:55:50", 
                "DevShopID": "9998", 
                "MallCardNo": "201701", 
                "OrderID": "PO201711131655502074783", 
                "PayableAmount": 0, 
                "PaymentAmount": 0, 
                "PayMethod": 0, 
                "PayTime": "0001/01/01 00:00:00", 
                "PayType": 0, 
                "PosOrderID": "3430", 
                "PostID": "456", 
                "Status": 1, 
                "TotalDiscount": 0, 
                "TradeSerialNo": null
            }
        ]
    }, 
    "Message": "ok", 
    "Extension": [ ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68



# 退款单创建

TIP

用于从猫酷生成并获取退款单号

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Refund/Add (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
CashierID string 是 收银员编号
DevShopID string 是 商户号
OrderID string 是 订单号
OutRefundID string 是 外部退款单号
PosID string 是 终端号
ReturnAmount int 是 退款金额（单位：分）
ReturnMethod int 是 退款方式

# 调用示例


{
    "CashierID": "abc", 
    "DevShopID": "123", 
    "OrderID": "PO201711091408485897569", 
    "OutRefundID": "121", 
    "PosID": "456", 
    "ReturnAmount": 1, 
    "ReturnMethod": 1
}
1
2
3
4
5
6
7
8
9
10
11

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
CreateTime string 是 创建时间
RefundID string 是 退款单号
# 返回示例

{
  "Code":1,
  "Data":
    {
       "CreateTime":"2012-09-03",
       "RefundID":"PO2334444332222"
    },
  "Message":null
}
1
2
3
4
5
6
7
8
9
10
11



# 退款结果通知

TIP

同步退款单的退款结果

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Refund/Inform (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
RefundID string 是 退款单号
RefundOrderID string 是 退款流水号
Status int 是 状态

# 调用示例


{
    "RefundID": "PU20000000020", 
    "RefundOrderID": "SD500000", 
    "Status": 1
}
1
2
3
4
5
6

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
  "Code":1,
  "Message":"操作成功！"
}
1
2
3
4
5
6



# 退款查询

TIP

根据条件查询商户的退款单

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Refund/Records (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
DevShopID string 二选一 商户号
MinID string 是 最小ID
PageSize int 是 每页条数
PosID string 二选一 终端号
RefundID string 否 退款单号
ReturnID string 否 退款流水号
SearchEndTime string 否 结束创建时间
SearchStartTime string 否 开始创建时间
Status int 否 退款状态（1.待退款 2.已退款 3.已取消）

# 调用示例


{

    "PageSize": 2, 
    "PosID": "456", 
}
1
2
3
4
5
6

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
Count int 是 页数
OrderInfoList List<RefundInfoModel> 是 退款单信息
# RefundInfoModel
名称 数据类型 必填 说明
CashierID int 是 收银员编号
CreateTime string 是 创建时间
DevShopID stirng 是 商户号
OutRefundID string 是 外部退款单号
PosID string 是 终端编号
RefundAmount int 是 退款金额
RefundOrderID string 是 退款单号
ReturnID string 是 退款流水号
ReturnMethod int 是 退款方式 （1.原路 2.现金）
Status int 是 退款状态（1.待退款 2.已退款 3.已取消）
# 返回示例

{
    "Code": 1, 
    "Data": {
        "Count": 11, 
        "OrderInfoList": [
            {
                "CashierID": "abc", 
                "CreateTime": "2017/11/14 09:52:56", 
                "DevShopID": "123", 
                "OutRefundID": "1", 
                "PosID": "456", 
                "RefundAmount": 1, 
                "RefundOrderID": "RO201711140952563551583", 
                "ReturnID": null, 
                "ReturnMethod": 1, 
                "Status": 1
            }, 
            {
                "CashierID": "abc", 
                "CreateTime": "2017/11/10 15:47:53", 
                "DevShopID": "123", 
                "OutRefundID": "24708a138ff5406ebe4d4dc366c276e0", 
                "PosID": "456", 
                "RefundAmount": 1, 
                "RefundOrderID": "RO201711101547534587081", 
                "ReturnID": "20171110154754202", 
                "ReturnMethod": 1, 
                "Status": 1
            }
        ]
    }, 
    "Message": "ok", 
    "Extension": [ ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36



# 订单取消

TIP

用于从猫酷生成并获取退款单号

接口地址：https://openapi10.mallcoo.cn/Pay/Pos/v1/Order/Cancel (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
OrderID string 是 订单号

# 调用示例


{
    "OrderID": "PO201711101206432588325", 
}
1
2
3
4
5

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
  "Code":1,
  "Message":"ok"
}
1
2
3
4
5
6
Last Updated: 2019/10/15 上午11:34:20

← 消息推送 →