Cashy 文档中心

创建收银台订单

API EndPoint

POST baseUrl + /api/payDesk

请求参数

参数名	必选	类型	示例值	字段说明
`currency`	`Y`	`string(32)`	COP	货币代码(`COP`)
`amount`	`Y`	`decimal(20,2)`	10000	金额10000-5000000
`reusableStatus`	`N`	`boolean`	不传默认 `false`	（false=不允许 true=允许）目前只能是false
`mchOrderNo`	`Y`	`string(32)`	1386556787811426305	商户订单号（不允许重复）
`expireTime`	`N`	`long`	3600	过期时间（单位：秒）不传则默认7天
`notifyUrl`	`Y`	`string(250)`	`https://merchant.com/webhooks`	回调地址
`nonceStr`	`Y`	`string(32)`	1863484722378907648	随机字符串
`realName`	`Y`	`string(32)`	Jeck	用户姓名 `不能有特殊字符、限制最长64个字符`
`phone`	`Y`	`string(32)`	52xxxxxxx	手机号 `格式要正确,尽量传真实的手机号`
`email`	`Y`	`string(64)`	`example@maildomain.com`	邮箱 `格式要正确,尽量传真实的邮箱`
`idType`	`Y`	`string(32)`	请参考付款人证件类型	付款人证件类型
`idCard`	`Y`	`string(32)`	`我们不校验真实性和合法性，错误的证件号可能导致部分交易失败`	付款人证件号
`returnUrl`	`N`	`string(250)`	`https://merchant.com/jump`	支付成功后同步跳转地址
`remark`	`N`	`string(32)`	不传默认 `remark`	备注（请使用英文字符或不带重音的西语）

TIP

用户信息将传送给银行校验，需填写真实且有效信息

请求示例

bash

curl -L 'baseUrl/api/payDesk' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"amount":10000,"idType":1,"mchOrderNo":"paydesk0000000001","idCard":"10351512345","remark":"payment","nonceStr":"17345xxxxxxx","realName":"jeson","reusableStatus":false,"expireTime":899,"phone":"57319312345","notifyUrl":"http://xxxxxx.com/cocashy/payin-notify","currency":"COP","email":"test@gmail.com"}'

响应参数

参数名	类型	参数说明
`merchantId`	`int`	商户Id
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`amount`	`decimal(20,2)`	金额
`payUrl`	`string(250)`	收银台Url
`expireTime`	`date`	过期时间

响应示例

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "paydesk0000000001",
    "orderNo": "PAYDESK000000001",
    "payUrl": "https://paydeskco.brcashypro.com/index.html?PAYDESK000000001",
    "amount": "10000",
    "expireTime": "2024-12-19 01:46:17"
  }
}

查询收银台订单

API EndPoint

POST baseUrl + /api/payDeskQuery

请求参数

参数名	必选	类型	示例值	字段说明
`mchOrderNo`	`N`	`string(32)`	1386556787811426305	商户订单号
`orderNo`	`N`	`string(32)`	PAYIN8551844049125523456	平台订单号
`nonceStr`	`Y`	`string(32)`	1863484722378907648	随机字符串

TIP

我们建议优先使用orderNo（平台订单号），平台订单号和商户订单号至少需要传递一个。

请求示例

bash

curl -L 'baseUrl/api/payDeskQuery' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d ' {"mchOrderNo":"202411301909131862936942783582208","nonceStr":"1138688daof9gnay3dt9j4wktxt1z99ww"}'

响应参数

参数名	类型	字段说明
`merchantId`	`int`	商户Id
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`payUrl`	`string(250)`	付款二维码，有些方式有二维码QRIS
`amount`	`decimal(20,0)`	金额
`fee`	`decimal(20,4)`	手续费
`orderStatus`	`string(32)`	代收订单状态枚举
`completionTime`	`date`	完成时间

响应示例

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "3002112",
    "mchOrderNo": "202411301909131862936942783582208",
    "orderNo": "PAYDESK39568551277959484616704",
    "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK39568551277959484616704",
    "amount": "1000000",
    "fee": "0",
    "orderStatus": "PAYING",
    "completionTime": null,
    "nonceStr": null
  }
}

收银台订单结果通知

通知地址由商户提供

POST Merchant NotifyUrl

异步通知请求参数

参数名	类型	说明
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`amount`	`decimal(20,2)`	金额
`fee`	`decimal(20,4)`	手续费
`payUrl`	`string(32)`	收银台Url
`orderStatus`	`string(32)`	收银台代收订单状态枚举
`completionTime`	`date`	完成时间
`nonceStr`	`string(32)`	随机字符串

异步通知请求示例

bash

curl -L 'merchant.com/webhooks/paydesk' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"amount":358320.00,"completionTime":"2024-12-02 12:07:06","fee":2500.0000,"mchOrderNo":"1313068703462109184","merchantId":"1002001","nonceStr":"1733116026894","orderNo":"PAYDESK27618551850988355260416","orderStatus":"SUCCESS","payCode":"OR.GPNQR..INOPROID_BS","payType":"41","payUrl":"https://payurl.com"}'

回调结构-成功回调结构-失败

json

{
  "amount": 358320.0,
  "completionTime": "2024-12-02 16:08:32",
  "fee": 9083.0,
  "mchOrderNo": "1313068703462109184",
  "merchantId": "1002001",
  "nonceStr": "1733130512894",
  "orderNo": "PAYDESK27618551850988355260416",
  "orderStatus": "SUCCESS",
  "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK27618551850988355260416"
}

json

{
  "amount": 358320.0,
  "completionTime": "2024-12-02 16:08:32",
  "fee": 9083.0,
  "mchOrderNo": "1313068703462109184",
  "merchantId": "1002001",
  "nonceStr": "1733130512894",
  "orderNo": "PAYDESK27618551850988355260416",
  "orderStatus": "FAIL",
  "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK27618551850988355260416"
}

TIP

当回调响应HTTP状态码为200、301或302时，我们认为商户已经成功接收并处理回调, 其它状态我们会认为商户处理回调失败。

回调失败后会在1,2,4,8,16,32,64,128,256,512分钟重试，一共重试回调10次

创建收银台订单 ​

查询收银台订单 ​

查询收银台订单 ​

收银台订单结果通知 ​

创建收银台订单

查询收银台订单

查询收银台订单

收银台订单结果通知