Cashy 文档中心

创建代收订单

TIP

POST baseUrl + /api/payIn

HTTP请求头

请求头	必选	值
`Content-Type`	`Y`	`application/json`
`MerchantId`	`Y`	`MerchantId`
`Sign`	`Y`	`Sign`

HTTP请求体

参数名	必选	类型	示例值	字段说明
`currency`	`Y`	`string(32)`	`TRY`	货币代码
`payType`	`Y`	`int`	123	请查看代收PayType枚举
`amount`	`Y`	`decimal(20,2)`	`[10-40000]` (最多2位小数)	金额
`reusableStatus`	`Y`	`boolean`	false	目前只能是false
`mchOrderNo`	`Y`	`string(32)`	mch12345	商户订单号（不允许重复）
`expireTime`	`Y`	`long`	3600 `暂时无效 10分钟过期`	过期时间（单位：秒）默认3600秒`不一定有效,部分通道支持`
`notifyUrl`	`Y`	`string(250)`	`https://merchant.com/webhooks`	回调地址
`nonceStr`	`Y`	`string(32)`	1863484722378907648xxx	随机字符串
`remark`	`Y`	`string(32)`	remark	备注（请使用英文字符或不带重音的西语）
`realName`	`N`	`string(32)`	(名字在前-姓在后中间使用 `-` 字符隔开例子嘉诚-李 )	用户姓名
`phone`	`N`	`string(32)`	+90xxxxxxx	手机号
`email`	`N`	`string(64)`	`example@maildomain.com`	邮箱
`idType`	`N`	`string(32)`	暂无	代收付款人证件类型
`idCard`	`N`	`string(32)`		付款人证件号

TIP

注意回调地址仅支持https或者http协议的地址，如果地址是ip地址，请务必使用公网域名。

HTTP响应体

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "100001",
    "mchOrderNo": "M1656908719283",
    "orderNo": "PAYIN8232154612109344768",
    "payCode": "646012000000015942",
    "payUrl": null,
    "amount": 100
  }
}

参数名	类型	说明
`merchantId`	`long`	商户Id
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`amount`	`decimal(20,0)`	金额
`orderFee`	`decimal(20,0)`	手续费
`payCode`	`string(32)`	付款账户VA
`payUrl`	`string(250)`	收银台支付地址

查询代收订单

API EndPoint

POST baseUrl + /api/payInQuery

请求参数

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

TIP

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

请求示例

bash

curl -L 'baseUrl/api/payInQuery' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"mchOrderNo":"1386556575370063873","nonceStr":"9459931608","orderNo":"PAYIN8551843837024997376"}'

响应参数

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

响应示例

支付中成功

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556575370063873",
    "orderNo": "PAYIN8551843837024997376",
    "payType": "43",
    "payCode": "",
    "payUrl": "https://m.dana.id/link/pay?bizNo=202412021112128001101660361270",
    "payDeskUrl": "https://idpaydesk2.brcashypro.com/views/pay.html?PAYIN8551843837024997376",
    "amount": "20000",
    "fee": "1700",
    "orderStatus": "PAYING",
    "completionTime": null,
    "nonceStr": null
  }
}

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556575370063873",
    "orderNo": "PAYIN8551843837024997376",
    "payType": "43",
    "payCode": "",
    "payUrl": "https://m.dana.id/link/pay?bizNo=202412021112128001101660361270",
    "payDeskUrl": "https://idpaydesk2.brcashypro.com/views/pay.html?PAYIN8551843837024997376",
    "amount": "20000",
    "fee": "1700",
    "orderStatus": "SUCCESS",
    "completionTime": "2024-12-02 15:40:50",
    "nonceStr": null
  }
}

异步回调通知

通知地址由商户提供

POST Merchant NotifyUrl

异步通知请求参数

参数名	类型	说明
`merchantId`	`int`	商户Id
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`channelOrderNo`	`string(32)`	渠道订单号
`payType`	`string(32)`	代收PayType枚举
`payCode`	`string(32)`	支付码
`payUrl`	`string(250)`	付款二维码
`amount`	`decimal(20,0)`	金额
`fee`	`decimal(20,4)`	手续费
`orderStatus`	`string(32)`	代收订单状态枚举
`completionTime`	`date`	完成时间

异步通知请求示例

bash

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

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

json

{
  "amount": 20000.0,
  "completionTime": "2024-12-02 12:07:06",
  "fee": 2500.0,
  "mchOrderNo": "1386503284355244033",
  "merchantId": "1002001",
  "nonceStr": "1733116026894",
  "orderNo": "PAYIN8551790545658687488",
  "orderStatus": "SUCCESS",
  "payCode": "OR.GPNQR..INOPROID_BS",
  "payType": "41",
  "payUrl": "https://payurl.com"
}

json

{
  "amount": 20000.0,
  "completionTime": "2024-12-02 12:07:06",
  "fee": 2500.0,
  "mchOrderNo": "1386503284355244033",
  "merchantId": "1002001",
  "nonceStr": "1733116026894",
  "orderNo": "PAYIN8551790545658687488",
  "orderStatus": "FAIL",
  "payCode": "OR.GPNQR..INOPROID_BS",
  "payType": "41",
  "payUrl": "https://payurl.com"
}

TIP

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

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

创建代收订单 ​

HTTP请求头 ​

HTTP请求体 ​

HTTP响应体 ​

查询代收订单 ​

异步回调通知 ​

创建代收订单

HTTP请求头

HTTP请求体

HTTP响应体

查询代收订单

异步回调通知