CanPay 开放 API

CanPay 为商户提供聚合支付能力。商户服务端调用开放 API 创建订单，用户在支付页完成付款后，平台向商户回调地址发送异步通知，商户亦可主动查询订单状态。

API 基础地址：https://canpay.vip

payUrl 域名：与 API 基础地址相同（生产 https://canpay.vip/pay/{token}，无端口）

通信协议：HTTPS · JSON · Content-Type: application/json

金额单位：人民币分（整数，例如 100 表示 1.00 元）

平台回调 IP：支付成功后平台向商户 notifyUrl 发起通知的出口 IP，请加入商户侧防火墙/白名单：

103.251.113.102

所有开放 API 请求均需携带 sign 字段。签名步骤如下：

1. 取请求 JSON 中所有非空参数（sign 本身不参与签名）

2. 按参数名 ASCII 码升序排序

3. 拼接为 key1=value1&key2=value2...

4. 末尾追加 &key=secretKey（商户密钥）

5. 对拼接字符串做 MD5，取 32 位小写十六进制

示例待签名字符串：

amount=100&clientIp=127.0.0.1&mchId=1234567890&notifyUrl=https://example.com/notify&outTradeNo=T20250101120000&reqTime=1735689600000&subject=测试商品&wayCode=6020&key=your_secret_key

商户发起收款，返回系统订单号与支付链接 payUrl，用户访问支付页扫码完成付款。

POST

请求参数：

请求示例：

{
  "mchId": "1234567890",
  "wayCode": 6020,
  "subject": "测试商品",
  "body": "测试描述",
  "outTradeNo": "T20250101120000",
  "amount": 100,
  "clientIp": "127.0.0.1",
  "notifyUrl": "https://example.com/notify",
  "reqTime": 1735689600000,
  "sign": "..."
}

响应参数（data）：

响应示例：

{
  "code": 0,
  "message": "success",
  "sign": "...",
  "data": {
    "mchId": "1234567890",
    "tradeNo": "20250101120000123456",
    "outTradeNo": "T20250101120000",
    "originTradeNo": "48243067968064",
    "amount": "100",
    "payUrl": "https://canpay.vip/pay/xxxxxxxx",
    "expiredTime": "1735691400000",
    "state": 0
  }
}

code 为 0 表示请求受理成功；业务结果以 data.state（订单状态）为准（state=0 且 payUrl 非空表示可支付）。

订单 state=1（支付成功）后，平台向统一下单时指定的 notifyUrl 发起 POST 异步通知（JSON）。

POST（平台 → 商户）

通知参数：

通知示例：

{
  "mchId": "1234567890",
  "tradeNo": "20250101120000123456",
  "outTradeNo": "T20250101120000",
  "originTradeNo": "48243067968064",
  "amount": 100,
  "subject": "测试商品",
  "body": "测试描述",
  "extParam": "",
  "state": 1,
  "notifyTime": 1735689700000,
  "sign": "..."
}

商户应返回：纯文本 SUCCESS 或 OK（大小写不敏感）。

平台回调 IP：

103.251.113.102

根据商户订单号查询订单最新状态与支付信息。

POST

请求参数：

响应参数（data）：

响应示例：

{
  "code": 0,
  "message": "success",
  "sign": "...",
  "data": {
    "mchId": "1234567890",
    "wayCode": 6020,
    "tradeNo": "20250101120000123456",
    "outTradeNo": "T20250101120000",
    "amount": "100",
    "state": 1,
    "payUrl": "https://canpay.vip/pay/xxxxxxxx",
    "successTime": "1735689700000",
    "createTime": "1735689600000",
    "notifyState": 1
  }
}

用于联调商户 notifyUrl：按平台订单号将订单置为 state=1（已支付），再向 notifyUrl 发送回调；通知次数 +1。

POST

请求参数：

请求示例：

{
  "mchId": "1234567890",
  "tradeNo": "P20250101120000abcd",
  "reqTime": 1735689600000,
  "sign": "..."
}

响应参数（data）：

更多通道请联系平台运营开通。

接口层 code 为 0 表示请求处理成功；业务结果以 data.state（订单状态）为准。