Cashy 文档中心

创建代收订单

API EndPoint

POST baseUrl + /api/payIn

请求参数

参数名	必选	类型	字段说明	示例
`currency`	`Y`	`string(32)`	货币代码	`GTQ`
`payType`	`Y`	`int`	代收支付产品编号	代收PayType枚举
`amount`	`Y`	`decimal(20,2)`	金额
`reusableStatus`	`Y`	`boolean`	是否多次支付	`false`
`mchOrderNo`	`Y`	`string(32)`	商户订单号	`mch12345`
`expireTime`	`Y`	`long`	过期时间	默认`3600`秒 `不一定有效,部分通道支持`
`notifyUrl`	`Y`	`string(250)`	回调地址	`https://merchant.com/payin/webhooks`
`nonceStr`	`Y`	`string(32)`	随机字符串	`1863484722378907648`
`remark`	`Y`	`string(32)`	备注	请使用英文字符或不带重音的西语
`realName`	`Y`	`string(64)`	代收付款人用户姓名	`限制最长64个字符名+姓中间空格隔开`
`idType`	`Y`	`string(32)`	代收付款人证件类型	代收付款人证件类型
`idCard`	`Y`	`string(32)`	付款人证件号	`危地马拉CUI 13位纯数字`
`phone`	`N`	`string(32)`	代收付款人手机号
`email`	`N`	`string(64)`	代收付款人邮箱

请求示例

bash

curl -L 'baseUrl/api/payIn' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"realName":"Reza Wijaya","amount":"20000.00","reusableStatus":false,"payType":"203","expireTime":3600,"mchOrderNo":"1386556787811426305","notifyUrl":"https://merchant.com/webhooks/payin","currency":"GTQ","remark":"Electronic Cigarettes","nonceStr":"16a5a70f43384134bfae33acc77132e0","realName":"Salay Madelyn","idType":"1","idCard":"3531848020101"}'

响应参数

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

响应示例

成功响应异常响应

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556787811426305",
    "orderNo": "PAYIN8551844049125523456",
    "payCode": "RN123456",
    "payUrl": "https://gcash.com/pay?bizNo=20241202111212800110166154827",
    "biller": "Gcash",
    "amount": "20000",
    "orderFee": "1700"
  }
}

json

{
  "msg": "Payin_Order_Error",
  "code": 500
}

查询代收订单

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,3,7,11,16,22,29,37,46,56分钟重试，一共重试回调10次

创建代收订单 ​

查询代收订单 ​

代收订单结果通知 ​

创建代收订单

查询代收订单

代收订单结果通知