接口说明
API 参考
接口说明
商户接入 PayCools 服务须遵循以下通讯协议、报文结构与签名规范,确保交易安全可靠。
1
通讯协议
| 类型 | 说明 |
|---|---|
| 传输方式 | 为保证交易安全性,采用 HTTPS 传输,且 TLS 版本不低于 1.2,详情参考 TLS 升级说明 |
| 提交方式 | 采用 POST 方法提交 |
| 数据格式 | 提交和返回数据都为 application/json 格式 |
| 字符编码 | 统一采用 UTF-8 字符编码 |
| 签名算法 | SHA256WithRSA |
| 签名要求 | 请求和接收数据均需要校验签名,详细方法请参考 配置与签名 |
| 判断逻辑 | 先判断协议字段返回,再判断业务返回,最后判断交易状态 |
2
报文结构
统一 API 请求参数
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 商户 APP ID,由 Platform 提供 |
| sign | 是 | string | param 的 RSA 签名 |
| param | 是 | string | 请求参数字符串 |
请求示例
{
"appId": "123456",
"sign": "abcdef",
"param": "{}"
}
HTTP 响应
{
"code": 10000,
"message": "Success",
"data": "<业务数据JSON>"
}
请求说明
- appId 是由 Platform 提供的固定值
- 根据具体接口文档构造请求参数,将请求参数格式化为 JSON 格式,作为 param 的值
- 使用 RSA 私钥对 param 进行签名,得到的值作为 sign 的值
3
请求地址
Prod 生产环境https://openapi.paycools.com/