接口调用方式说明
接口调用方式
公共请求参数说明
参数 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
appId | String | 是 | 32 | 财资云开放平台提供给开发者的应用ID |
systemCode | String | 否 | 32 | 财资云开放平台提供给开发者的应用编码 |
command | String | 是 | 128 | 接口编码 |
version | String | 是 | 8 | 接口版本,无特殊说明统一填写 1.0.0 |
timestamp | String | 是 | 32 | 时间戳,格式yyyyMMddHHmmss |
charset | String | 是 | 16 | 请求使用的字符集编码,通用编码为UTF-8 |
format | String | 是 | 32 | 目前仅支持JSON |
signType | String | 是 | 8 | 生成签名字符串所使用的签名算法类型,目前支持RSA2和SM2,推荐使用RSA2 |
sign | String | 是 | 1024 | 加签内容字符串, 详见签名 |
bizContent | String | 是 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体内容参照接口文档 | |
encryptType | String | 否 | 3 | 加密类型,仅支持AES |
notifyUrl | String | 否 | 1024 | 支付结果通知地址,仅在调用创建支付单/创建应付单接口中必填,其他接口调用时无需填写 |
公共响应参数说明
参数 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
code | String | 是 | 32 | 网关响应码 |
msg | String | 是 | 32 | 网关响应描述 |
subCode | String | 是 | 32 | 业务返回码 |
subMsg | String | 是 | 32 | 业务返回码描述 |
sign | String | 是 | 32 | 签名 |
公共响应码说明
网关响应码 | 网关响应描述 | 业务返回码 | 业务返回码描述 |
---|---|---|---|
0 | 接口调用成功,调用结果请参考具体的业务接口文档所对应的业务返回参数。 | ||
1 | 服务不可用 | gateway-service-invalid | 网关自身的未知错误 |
1 | 服务不可用 | business-service-invalid | 业务系统暂不可用 |
2 | 缺少必填参数 | missing-tenant-id | 缺少tenantId参数 |
2 | 缺少必填参数 | missing-command | 缺少指令参数 |
2 | 缺少必填参数 | missing-timestamp | 缺少时间戳参数 |
2 | 缺少必填参数 | missing-version | 缺少版本参数 |
2 | 缺少必填参数 | invalid-version | 无效的版本参数 |
2 | 缺少必填参数 | missing-sign-type | 缺少签名类型参数 |
2 | 缺少必填参数 | missing-sign | 缺少签名参数 |
3 | 参数非法 | invalid-tenant-id | 无效的tenantId参数 |
3 | 参数非法 | invalid-command | 无效的指令参数 |
3 | 参数非法 | invalid-format | 无效的业务内容数据格式,暂只支持json格式 |
3 | 参数非法 | invalid-charset | 无效的字符集,暂只支持UTF-8 |
3 | 参数非法 | invalid-timestamp | 非法的时间戳参数 |
3 | 参数非法 | invalid-sign-type | 无效的签名类型 |
3 | 参数非法 | invalid-sign | 无效的签名 |
3 | 参数非法 | invalid-encrypt-type | 无效的加密类型 |
3 | 参数非法 | invalid-encrypt | 加密异常 |
3 | 参数非法 | missing-signature-config | 验签出错,对应签名算法的公钥未配置 |
3 | 参数非法 | decryption-error-not-valid-encrypt-key | 解密出错, 加密密钥未配置或格式错误 |
3 | 参数非法 | invalid-decrypt | 解密异常 |
4 | 无效请求 | invalid-media-type | 无效的请求数据格式 |
5 | 指令权限不足 | insufficient-command-permissions | 请求指令权限不足 |
9 | 业务处理失败 | 对应业务错误码,明细错误码参见具体的业务接口文档。 |
响应示例
{
"yocyl_account_third_balance_query_response": {
"code": "0",
"msg": "success",
"currentPageNo": 1,
"pageSize": 10,
"total": 1,
"totalPages": 1,
"records": [
{
"id": "1510104508622237697",
"accountNumber": "1234567890",
"accountName": "1234567890",
"balanceDate": "",
"currencyCode": "",
"currentBalance": "",
"currentBalanceView": "",
"bankBalance": "",
"bankBalanceView": "",
"memo": ""
}
]
},
"sign": "TQNv4uY+K6WDWMa5uh+SreIM1n4E36z6R6qOe3qeTd7puteJ3jfnI/7PrCkr4Bvmgwg748PLyLvkqjirT1mcuaKoMzaos9kakLjX5WbVoAfDLNpZW82LfCnItcXgCLrhbLi4DaRrLJDNbprqg5pKxNvlkJJKbcMPa4WVNl+HUL1CtQPkRN8k3OuLb4jeiFJwjgAi5KrIARDuyNRMSYKmLfT3gZqUEWWz84AGQb5iqBsBeS3eFfhpTup4zK+Y3FnClxmhCT86aoDdaLuDMfPvaS+XRV7R5pKO6HsPrMJdDxirhBTC9Wtb7XR3yb7NzAffWf3mEAHn+m/CyRNRbi2+2g=="
}
{
"yocyl_basic_employee_batchquery_response": {
"code": "1",
"msg": "服务不可用",
"subCode": "gateway-service-invalid",
"subMsg": "网关自身的未知错误"
},
"sign": "IDtsQNPrm9YL1Nj0NApd2NoK9Kuh8lIiyNe40ywwF4S4Su1vWfYZ3jBflz4OlQyEXY30ELbi3R1LRr8Jk15stBSRnPtjlLL4Gu9WDCclG4QRfdLj+TuHm+tOYBvMpFRUPXwVN68Qdk+0HTSS6olGKipeexuW+DoE4VcweFMALAeHRlAtvDyfFGeAi+zgDqsZOYRhAuNk1CZr3+HCuRJEpdNLEcrMyWFxPV/1MNXy1D9kJcVKGmilrgcRw91Rr9EPbjJQaPYewD8AVUdFJjIsP4e53p7PVzJOuhkQbEkLK+eONven+hN7e/CYLJ8Ufl9ctGX1fQIVXgOuPouUi9M7wg=="
}
修改于 2023-07-31 07:52:13