创建代收订单

HTTP请求信息

TIP

POST baseUrl + /api/payIn

HTTP请求头

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

HTTP请求体

参数名	必选	类型	示例值	字段说明
currency	Y	string(32)	CLP	货币代码
payType	Y	int	200	请查看 代收PayType枚举
amount	Y	decimal(20,0)	1000-5000000	金额
reusableStatus	Y	boolean	false	目前只能是false
mchOrderNo	Y	string(32)	mch12345	商户订单号（不允许重复）
expireTime	Y	long	3600	过期时间（单位：秒）默认3600秒 不一定有效,部分通道支持
notifyUrl	Y	string(250)	https://acb.com/	回调地址
nonceStr	Y	string(32)	162838128	随机数
realName	Y	string(32)	Jack	付款人姓名 ，不做真实性校验限制最长64个字符
phone	Y	string(32)	569NNNNNNNN	付款人手机号 ，用户真实手机号
email	Y	string(64)	example@maildomain.com	付款人邮箱 ，请尽量提供真实邮箱地址
idType	Y	string(32)	1	请参考代收付款人证件类型
idCard	Y	string(32)	11.111.111-1	付款人证件号,会对RUT进行格式校验
goodsSubject	N	string(32)	apple	商户标题
goodsBody	N	string(32)	apple	商品描述
remark	Y	string(32)	remark	备注 （请使用英文字符或不带重音的西语）

INFO

1. 代收发起 idType,增加代收付款人证件类型。 （2023/09/22）

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)	收银台支付地址

测试用例

对于代收交易，请使用以下卡进行测试。

卡类型	卡信息	结果
VISA	4051 8856 0044 6623 CVV 123	成功
AMEX	3700 0000 0002 032 CVV 1234	成功
MASTERCARD	5186 0595 5959 0568 CVV 123	失败
Redcompra	4051 8842 3993 7763	成功
Redcompra	5186 0085 4123 3829	失败
Prepago VISA	4051 8860 0005 6590 CVV 123	成功
Prepago MASTERCARD	5186 1741 1062 9480 CVV 123	失败

当出现带有RUT和密钥的身份验证时，必须使用RUT 11.111.111-1 ,密钥123 。

查询代收订单

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响应体

{
  "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

异步通知请求体

{
  "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次