# 1. 收银台下单接口

# 简要描述

  • 商户支付-创建收银台订单接口

# 请求URL

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

# 请求方式

  • POST

# 请求头

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

# 请求体参数

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

# param参数

参数名 必填 类型 长度限制 示例 说明
timestamp long - 1677495496979 当前时间戳
mchOrderId string 1-32 CCP20220428011068111 商户订单id, 格式:字母+数字,1-32位
merchantLogo string - 商户logo, 展示在收银台页面中
language string - - 收银台显示语言 (EN, IN, TH), 不传则显示国家对应的语言或英语
countryCode string - - 国家编码 (PH, ID, MY, TH)
currency string - - 标价币种 (PHP, IDR, MYR, THB)
settlementCurrency string - - 结算币种 (PHP, IDR, MYR, THB)
channelTypeList array - - 渠道类型 (QR, ONLINE_BANKING, EWALLET, BANK_TRANSFER, CARD), 用于限制收银台可用的渠道类型
channelCodeList array - 参考列表 channel code, 限制使用具体的渠道, 当传递该字段时对应的channelType必传
amount long - - 收款金额(单位为分, 当国家为印尼时,单元为元)
customerName string 1-100 - 付款人姓名
email string 1-150 - 付款人邮箱
mobile string 9-12 - 付款人电话
expireSeconds long - - 过期秒数, 默认30分钟
notifyUrl string 1-200 - 商户交易通知 URL
redirectUrl string 1-500 - 重定向 URL
remark string 1-250 - 收单备注
virtualAccountName string - - va姓名, 不传则默认商户名

# 请求示例

# 请求体

{
   "appId": "733b887a4a784708bb369524db5b6ded",
   "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
   "param": "{\"timestamp\":1715595802,\"mchOrderId\":\"10e5595801938341100\",\"merchantLogo\":\"https://test.img\",\"currency\":\"PH\",\"settlementCurrency\":\"PHP\",\"countryCode\":\"PH\",\"channelTypeList\":null,\"channelCodeList\":null,\"customerName\":\"name\",\"email\":\"test@email.com\",\"mobile\":\"09123456789\",\"amount\":10000,\"expireSeconds\":3600,\"remark\":\"remark\",\"notifyUrl\":\"https://www.test.com\",\"redirectUrl\":\"https://www.test.com\"}"
}

如何构造请求体


# 响应参数

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

# data参数

参数名 类型 说明
checkoutId string checkout订单id
checkoutUrl string checkout收银台页面链接
status string 状态
expiresTime string 过期时间

# 响应示例


{
  "code": 10000,
  "message": "Success",
  "data": {
    "checkoutId": "CH1789964654026559488",
    "checkoutUrl": "https://cashier.paycools.com/checkout/NzQxPl1wE-cdtloi1h0pTgc23ZcdGdXiGGZ2YvywJ-o=",
    "status": "PENDING",
    "expiresTime": "2024-05-14 15:27:00"
  }
}

响应码集合

# 返回失败案例

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