Cashy 文档中心

创建代收订单

HTTP请求信息

TIP

POST baseUrl + /api/payIn

HTTP请求头

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

HTTP请求体

参数名	必选	类型	示例值	字段说明
`currency`	`Y`	`string(32)`	`BRL`	货币代码
`payType`	`Y`	`int`	200	请查看代收PayType枚举
`amount`	`Y`	`decimal(20,2)`	`[5,100000]`	金额
`reusableStatus`	`Y`	`boolean`	false	目前只能是false
`mchOrderNo`	`Y`	`string(32)`	mch12345	商户订单号（不允许重复）
`expireTime`	`Y`	`long`	3600	过期时间（单位：秒）默认3600秒 `不一定有效,部分通道支持`
`notifyUrl`	`Y`	`string(250)`	`https://acb.com/`	回调地址
`redirectUrl`	`N`	`string(250)`	`https://acb.com/`	支付成功后重定向地址
`nonceStr`	`Y`	`string(32)`	162838128	随机数
`remark`	`Y`	`string(32)`	remark	备注（`请使用英文字符或不带重音的西语`）
`realName`	`N`	`string(32)`	Jack	用户姓名`限制最长64个字符`
`phone`	`N`	`string(32)`	+57xxxxxxx	手机号
`email`	`N`	`string(64)`	`example@maildomain.com`	邮箱
`idType`	`N`	`string(32)`	目前只支持CPF `建议传`	付款人证件类型
`idCard`	`N`	`string(32)`	idType非空时必填 `建议传`	代收付款人CPF证件号
`goodsSubject`	`N`	`string(32)`	apple	商户标题
`goodsBody`	`N`	`string(32)`	apple	商品描述

TIP

请注意：

当idType 传递时，idCard参数必传，并且我们会做基本的CPF格式校验。(123.456.789-09 / 12345678909) 这两种格式均支持。
如果您需要在银行侧开启收款人CPF校验，请联系我们的运营同事开通。（此功能开启后，代收订单仅接受对应CPF的付款人付款）

TIP

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

HTTP响应体

JSON 示例

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,2)`	金额
`orderFee`	`decimal(20,2)`	手续费
`payCode`	`string(32)`	付款账户VA
`payUrl`	`string(250)`	收银台支付地址

查询代收订单

HTTP请求信息

TIP

POST baseUrl + /api/payInQuery

HTTP请求头

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

HTTP请求体

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

TIP

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

HTTP响应体

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "100001",
    "mchOrderNo": "M1656752128806",
    "orderNo": "PAYIN8231497473279467520",
    "payType": "1",
    "payCode": "646012000000015887",
    "payUrl": null,
    "amount": 100.0,
    "fee": null,
    "orderStatus": "PAYING",
    "completionTime": null
  }
}

参数名	类型	字段说明
`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`	完成时间

TIP

fee 和 completionTime 仅在订单成功支付时有值。completionTime的格式为 yyyy-MM-dd HH:mm:ss。

异步回调通知

异步通知请求

TIP

POST : notifyUrl

回调地址由商户提供或透传。

异步通知请求头

HeaderName	Required	Value
`Content-Type`	`Y`	`application/json`
`MerchantId`	`Y`	`MerchantId`
`Sign`	`Y`	`Sign`

异步通知请求体

json

{
  "orderStatus": "SUCCESS",
  "amount": 10000.0,
  "fee": 0,
  "mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
  "merchantId": "100001",
  "orderNo": "PAYDESKxxxxxxxxxxx",
  "payUrl": "xxxxxxxxxxxx",
  "completionTime": "2022-08-08 08:08:08",
  "nonceStr": "xxxxxxxxxx"
}

参数名	类型	说明
`merchantId`	`int`	商户Id
`mchOrderNo`	`string(32)`	商户订单号
`orderNo`	`string(32)`	平台订单号
`amount`	`decimal(20,2)`	金额
`fee`	`decimal(20,4)`	手续费(支付成功后才有手续费)
`payUrl`	`string(32)`	收银台Url
`orderStatus`	`string(32)`	订单状态（PAYING=支付中 SUCCESS=成功）
`completionTime`	`date`	完成时间（未成功，此值为空）`yyyy-MM-dd HH:mm:ss`
`nonceStr`	`string(32)`	随机数

TIP

Http响应状态码为200、301或302表示已正常发送回调,其它状态码我们会认为回调失败。回调失败后会在1,2,4,8,16,32,64,128,256,512分钟重试，一共重试回调10次

创建代收订单 ​

HTTP请求信息 ​

HTTP请求头 ​

HTTP请求体 ​

HTTP响应体 ​

查询代收订单 ​

HTTP请求信息 ​

HTTP请求头 ​

HTTP请求体 ​

HTTP响应体 ​

异步回调通知 ​

异步通知请求 ​

异步通知请求头 ​

异步通知请求体 ​

创建代收订单

HTTP请求信息

HTTP请求头

HTTP请求体

HTTP响应体

查询代收订单

HTTP请求信息

HTTP请求头

HTTP请求体

HTTP响应体

异步回调通知

异步通知请求

异步通知请求头

异步通知请求体