批量同步接口
- 接口:common/userAccounts/v2/batch
- Method:POST
- 数据格式:JSON
- 限流信息:150次每天和50次每小时
- 多语言环境:在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
- 接口说明:该接口用作人员银行账户信息的批量同步,在整批数据中如果只有几条数据因为其他原因失败,那么只有这几条数据不会被处理,其他数据仍会被正常处理
- 其他补充信息:单次数据量过大时候(超过200条)会全部转为异步处理,具体参考回调示例
参数:
请求参数
字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度限制(字节) |
bizId |
String |
当前次接口同步的唯一标识 |
TRUE |
36 |
timestamp |
long |
当前次接口同步对应的时间戳 |
TRUE |
13 |
full_data |
String |
是否禁用这批数据所有账号(Y/N,默认为N) |
FALSE |
1 |
data |
Array |
当前次接口同步的数据集合 |
TRUE |
无 |
data.code |
String |
银行账号 |
TRUE |
255 |
data.bank_name |
String |
银行名称 |
FALSE |
255 |
data.bank_code |
String |
银行代码 |
FALSE |
255 |
data.employee_number |
String |
员工编号 |
TRUE |
64 |
data.account_name |
String |
银行账号名 |
TRUE |
255 |
data.bank_branch |
String |
支行名称 |
FALSE |
255 |
data.state |
String |
省 |
FALSE |
255 |
data.city |
String |
市 |
FALSE |
255 |
data.bank_swift_id |
String |
交易行代码 |
FALSE |
255 |
data.primary_flag |
String |
是否为默认银行(Y/N) |
FALSE |
1 |
data.enabled_flag |
String |
是否启用标志(Y/N,默认为Y) |
FALSE |
1 |
data.currency_code |
List |
币种信息 |
FALSE |
255 |
返回参数
字段名称 |
字段类型 |
字段描述 |
bizId |
String |
当前次接口同步的唯一标识 |
resCode |
Integer |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
created |
String |
创建成功的条数 |
updated |
String |
更新成功的条数 |
validatorErrors |
Array |
字段强校验不合格的数据 |
dbErrors |
Array |
数据持久化时出现错误的数据 |
warnings |
Array |
字段弱校验不合格的数据,任会做同步处理 |
示例:
请求数据
{
"bizId" : "4e13e967-50c3-40a3-bde2-7b4aa164ece7",
"timestamp" : 1594017230978,
"data" : [ {
"code" : "6222600263331072444",
"bank_name" : "中国招商银行",
"bank_code" : "105100000017",
"employee_number" : "E000517",
"account_name" : "王海波",
"bank_branch" : "招商银行",
"primary_flag" : "Y",
"currency_code" : ["CNY"]
}, {
"code" : "6222600263331072445",
"bank_name" : "中国招商银行",
"bank_code" : "105100000017",
"employee_number" : "E0005331111",
"account_name" : "王海波",
"bank_branch" : "招商银行",
"primary_flag" : "Y"
}, {
"code" : "",
"bank_name" : "中国招商银行",
"bank_code" : "105100000017",
"employee_number" : "E000521",
"account_name" : "王海波",
"bank_branch" : "招商银行",
"primary_flag" : "Y"
} ]
}
返回数据
{
"resCode" : 200000,
"resMsg" : "success",
"bizId" : "4e13e967-50c3-40a3-bde2-7b4aa164ece7",
"data" : {
"validatorErrors" : [ {
"code" : "",
"messages" : [ "编码不能为空" ]
}, {
"code" : "E0005331111",
"messages" : [ "该员工E0005331111不存在" ]
} ],
"created" : "此次请求新建成功了0条数据",
"warnings" : [ ],
"dbErrors" : [ ],
"updated" : "此次请求更新成功了1条数据"
}
}