API Doc

# 2. 收银台查询接口

# 简要描述

  • 商户支付-收银台订单查询接口

# 请求URL

  • {domain}/open-api/payment/checkout/query

# 请求方式

  • POST

# 请求头

参数名 必选 类型 说明
Content-Type mandatory string application/json

# 请求体参数

参数名 必选 类型 说明
appId 是 string 应用APPID
param 是 string 参数体
sign 是 string 签名

# param参数

参数名 必填 类型 长度限制 示例 说明
timestamp 是 long - 1677495496979 当前时间戳
checkoutId 是 string 1-32 -

# 请求示例

# 请求体

{
   "appId": "733b887a4a784708bb369524db5b6ded",
   "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "param": "{\"timestamp\":1715595802,\"checkoutId\":\"CH1789920394875113472\"}"
}

如何构造请求体

# 响应参数

参数名 类型 说明
code integer 响应码
message string 响应信息
data Object 数据

# data参数

参数名 类型 说明
checkoutId string checkout订单id
status string checkout订单状态 (PENDING, PAID, CLOSED)
expiresTime string 过期时间
transactionList string 成功交易列表
- transactionId string PayCools 交易流水号
- transactionStatus string 交易状态(PENDING, COMPLETED, FAILED)
- channelCode string 支付渠道产品
- transactionCreateTime string 交易创建时间
- transactionReturnTime string 交易完成时间

# 响应示例


{
  "code": 10000,
  "message": "Success",
  "data": {
    "checkoutId": "CH1789920394875113472",
    "status": "PAID",
    "expiresTime": "2024-05-14 15:27:32",
    "transactionList": [
      {
        "transactionId": "CU4Y9920490660433920",
        "transactionStatus": "COMPLETED",
        "channelCode": "PH_GCASH_URL",
        "transactionCreateTime": "2024-05-13 15:27:55",
        "transactionReturnTime": "2024-05-13 15:29:21"
      }
    ]
  }
}

响应码集合

# 返回失败案例

{
    "code":1002,
    "message":"merchant white ip forbidden"
}

← 3. 收银台订单获取可用渠道接口 →