# 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`, `PAYLATER`), 用于限制收银台可用的渠道类型
channelCodeList	否	array	-	参考列表	channel code, 限制使用具体的渠道, 当传递该字段时对应的channelType必传
amount	是	long	-	-	收款金额（单位为分, 当国家为印尼时，单元为元）
customerName	是	string	1-128	-	付款人姓名
email	是	string	1-128	-	付款人邮箱
mobile	是	string	10-14	-	付款人电话
expireSeconds	否	long	-	-	过期秒数, 默认30分钟
notifyUrl	是	string	1-256	-	商户交易通知 URL
redirectUrl	是	string	1-512	-	重定向 URL
remark	否	string	1-256	-	收单备注
virtualAccountName	否	string	-	-	va姓名, 不传则默认商户名
goodsDetails	否	List<goodsDetail>	-	-	商品信息当使用`PAYLATER`时，该字段必填，否则不可用注: 如果传入该对象，则内层必填字段必须传入
billingAddress	否	billingAddress	-	-	账单地址信息当使用`PAYLATER`时为必要字段。商户可通过接口传入该值；若未传值，系统将通过收银台界面提示用户补充填写。注: 如果传入该对象，则内层必填字段必须传入

# goodsDetail参数

参数名	必填	类型	长度限制	示例	说明
name	是	string	1-128	-	商品名称
price	是	long	-	-	商品单价 (商品总价格必须与收款金额一致)
quantity	是	integer	1-9999	-	商品数量
sku	是	string	1-64	-	SKU ID (商家分配的用于识别商品的唯一ID)
url	否	string	1-256	-	商品链接地址当channelCode=`ID_INDODANA_URL`时必传
category	是	string	1-64	-	商品分类参考值: `airlines` `arts-crafts-and-collectibles` `automotive` `baby` `beauty-and-fragrances` `biller` `books-and-magazines` `business-to-business-including-mlm` `charity-and-non-profit` `clothing` `community` `digital-content` `electronics-and-telecom` `entertainment-and-media` `financial-services-and-products` `financial-services-and-technology` `food-and-beverage` `food-retail-and-service` `games-voucher` `gifts-and-flowers` `government` `health-and-personal-care` `home-and-garden` `hotel-and-travel` `insurance` `marketplace` `nonprofit` `offline-store` `others` `over-the-air` `overseas` `pets-and-animals` `property` `public-services` `religion-and-spirituality` `retail` `services` `sports-and-outdoors` `telco` `ticketing` `toys-and-hobbies` `transportation` `travel` `vehicle-sales` `vehicles-service-and-accessories` `fee` `offline` 如果找不到参考值，可使用 `others`

# billingAddress参数

参数名	必填	类型	长度限制	示例	说明
name	是	string	1-128	-	付款人名称
address	是	string	1-512	-	付款人地址
city	是	string	1-512	-	城市
state	否	string	1-512	-	省
postalCode	是	string	5-10	-	邮政编码
mobile	是	string	10-14	-	付款人电话
countryCode	是	string	1-32	-	国家编码 (需与当前渠道类型所属国家保持一致)

# 请求示例

# 请求体

{
   "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":21016,
    "message":"Merchant ip forbidden"
}

← 对账文件下载 2. 收银台查询接口 →