版本 | 日期 | 备注 |
1.0 | 2020.1.20 | 创建接口文档 |
2.0 | 2020.3.19 | 修改 |
3.0 | 2020.4.22 | 修改 |
威海工资监管平台所有API接口均基于Post方式请求调用。
该接口文档适用于已经对接过银行，可以获取银行账户信息，已实现线上工资代发流程的第三方平台。
1.2 接口调用流程
统一返回参数结构
参数名称 | 参数说明 |
success | 接口执行结果 true 成功 false 失败 |
msg | 处理结果消息 |
data | 接口处理完毕返回的数据（请参见具体接口的返回信息）。 |
返回的Json格式:
{”success”:接口返回状态,”msg”:详细消息,”data”:{…}}
接口为异步接口
请求： /api-app/upload/uploadApi
参数：
appKey | 授权key | 字符串 |
appSecret | 安全码 | 字符串 |
customerName | 客户名称 | 字符串 |
methodName | 上传接口 | 字符串 |
data | 参数 | 具体接口参数 |
请求：/api-app/upload/getTaskResultApi
参数：
appKey | 授权key | 字符串 |
appSecret | 安全码 | 字符串 |
customerName | 客户名称 | 字符串 |
taskId | 任务id | 字符串 |
data返回数据：
success | true/false |
data | 如果success=true，data={ "taskId": "FE85FBCE6E1140B48F46CFEF8EFA2B99", "result": "{\"code\":\"90004\",\"msg\":\"手机号码格式不正确\",\"success\":false}", "state": 3 (1：未处理2：处理中3：处理完成) } |
msg | 如果success=false，msg=任务不存在/没有此客户鉴权 |
接口信息 | |||
Method | AddAccount | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 添加/修改工资账户，修改时根据银行账号修改 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
number | string | 是 | 银行账号 唯一 |
name | string | 是 | 账户名称 |
bankType | string | 是 | 银行类型，参考3.1 银行类型字典表 |
bankName | string | 是 | 开户行 |
bankNumber | string | 否 | 开户行账号 |
type | string | 是 | 账户类型(1-工人工资专户,2-总包工资保证金账户) |
accidentNumber | string | 否 | 事故序号(仅保证金账户) |
tradeDate | string | 否 | 事故交易日期 |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
result 说明 | |||
accountId | string | 银行账户id | |
接口信息 | |||
Method | UpdateAccountBalance | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 更新余额状态信息接口-先从银行获取余额状态信息，修改时根据银行账号修改 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
number | string | 是 | 银行账号 唯一 |
balance | string | 是 | 账户余额 |
useBalance | string | 是 | 账户可用余额 |
state | string | 是 | 账户状态(-1-未开 户,0-正常及部分冻 结,2-全部冻结,3-结 清,7-单向冻结) |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
接口信息 | |||
Method | UpdateAccountBailTransference | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 更新保证金状态信息接口-先从银行获取保证金信息，修改时根据银行账号修改 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
number | string | 是 | 银行账号 唯一 |
ctrlState | string | 是 | 圈存状态(-1未开户,0圈存已解除,1已圈存) |
ctrlBalance | string | 是 | 圈存金额 |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
接口信息 | |||
Method | AddProjectAccount | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 添加项目银行卡关联信息接口，修改时根据项目名称和账户表ID修改 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
projectName | string | 是 | 项目名称 |
accountId | string | 是 | 账户表id(为2.1接口返回的账户ID) |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
接口信息 | |||
Method | AddWorkerAccount | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 添加工人银行卡信息接口，修改时根据工人身份证号修改 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
bankType | string | 是 | 银行类型，参考3.1 银行类型字典表 |
bankName | string | 是 | 银行具体信息 |
bankNumber | string | 是 | 银行卡号 |
idcardNumber | string | 是 | 工人身份证号 唯一 |
fileThePath | string | 否 | 银行卡反面图片网络地址 |
fileIsPath | string | 否 | 银行卡正面图片网络地址 |
projectName | string | 是 | 项目名称 |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
接口信息 | |||
Method | AddRoll | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 添加工资单信息接口 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
payRollName | string | 是 | 工资单名称 |
payMonth | string | 是 | 发放工资的年月 格式：(YYYY-MM) |
status | string | 否 | 处理状态(3-银行已处理) |
attachFiles | string | 是 | 附件 存放工资单附件网络路径(上传附件时有对应的附件上传接口) |
projectName | string | 是 | 项目名称 |
contractorProjectName | string | 是 | 建筑活动工程编码（总包）名称 (单位名称) |
subContractorProjectName | string | 是 | 建筑活动工程编码（分包）名称(参建单位名称) |
teamName | string | 是 | 班组名称 |
payDate | string | 是 | 发放工资的时间 ( YYYY-MM-dd HH-mm-SS ) |
payStartDate | string | 是 | 发放开始 |
payEndDate | string | 是 | 发放结束 |
organizationName | string | 是 | 参建单位名称 |
bankStatus | string | 是 | 银行方处理状态(8-发放成功,9-发放失败,10-部分失败) |
statNo | string | 是 | 银行批次返回状态 |
statMsg | string | 是 | 银行批次状态信息 |
payType | string | 是 | 发放方式（1-线上代发） |
bankType | string | 是 | 发放银行类型 |
bankName | string | 是 | 发放银行名称，参考3.1 银行类型字典表 |
bankNumber | string | 是 | 银行卡号 |
projectName | string | 是 | 项目名称 |
jbrIdcardNumber | string | 是 | 经办人身份证号 |
upuserIdcardNumber | string | 是 | 上报人员身份证号 |
receipt | string | 是 | 回执单网络地址 |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
result 说明 | |||
payRollCode | string | 工资单编号 | |
接口信息 | |||
Method | AddRollDetail | ||
返回方式 | 响应体(JSON) | ||
接口说明 | 添加工资单明细信息接口 | ||
输入参数 | |||
名称 | 类型 | 是否必需 | 备注 |
payRollCode | string | 是 | 工资单编号 |
idcardType | string | 是 | 证件类型 |
idcardNumber | string | 是 | 工人身份证号 |
workerType | string | 是 | 务工工种 |
totalPayAmount | string | 是 | 应发金额 |
actualAmount | string | 否 | 实发金额 |
days | string | 是 | 出勤天数 |
workHours | string | 是 | 总工时 |
balanceDate | string | 是 | 银行发放日期 |
payRollbankCardNumber | string | 是 | 银行卡号 |
payRollbankName | string | 是 | 开户行名称 |
payRollbankCode | string | 是 | 工资发放银行编号 |
payTotalAmount | string | 是 | 该人员在本工程累计支付总金额（元） |
settleTotalAmount | string | 是 | |
payStatus | string | 是 | 银行方处理状态(8-发放成功,9-发放失败) |
reissueStatus | string | 是 | 补发状态(0:不补发 1:补发) |
reissueAmount | string | 是 | 补发金额 |
reissueDate | string | 是 | 补发日期 |
workerName | string | 是 | 工人名称 |
teamName | string | 是 | 班组名称 |
organizationName | string | 是 | 参建单位名称 |
projectName | string | 是 | 项目名称 |
batchNumber | string | 是 | 批次号 |
serialNumber | string | 是 | 序号 |
retCode | string | 是 | 返回码 |
retMsg | string | 是 | 返回信息 |
workerName | string | 是 | 工人姓名 |
unit | string | 是 | 计量单位 |
price | string | 是 | 计量单价 |
waterNumber | string | 是 | 交易流水号 |
响应体字段 | |||
名称 | 类型 | 是否必需 | 备注 |
taskId | string | 是 | 请求序列编码 |
编码 | 类型 |
001 | 青岛银行 |
100 | 中国邮政储蓄银行（收单） |
102 | 工商银行 |
104 | 中国银行 |
105 | 中国建设银行 |
105 | 中国建设银行 |
203 | 中国农业发展银行 |
301 | 交通银行 |
302 | 中信银行 |
303 | 中国光大银行 |
304 | 华夏银行 |
305 | 中国农业银行 |
308 | 招商银行 |
309 | 兴业银行 |
310 | 上海浦东发展银行 |
313 | 城市商业银行 |
330 | 齐商银行 |
333 | 威海市商业银行 |
334 | 乳山农商银行 |
335 | 荣成农商银行 |
501 | 汇丰银行 |
505 | 中国银行（香港）有限公司 |
9001 | 威海农商银行 |
部分内容由用户投稿或者来源于网络，如有侵权，请联系底部邮箱进行删除！非常感谢您的支持！
