口座残高情報取込
OpenAPI説明
本APIは、口座残高情報を一括取り込む際に利用します
リクエストURI
/api/openapi/btob/account/balance/import
リクエスト形式
POST
リクエスト例
{
"accountBalanceDatas": [
{
"tenantId": "1214732595705114600",
"inquiryResult": "1",
"failReason": "ユーザによってABS側の残高照会権限を解除されている",
"saasCode": "ABS",
"identificationNumber": "2024081201234561",
"bankCode": "0000",
"branchCode": "091",
"accountType": "1",
"accountNumber": "1234567",
"accountName": "XXXXXXXXXX",
"baseDate": "2024-02-06",
"baseTime": "16:02:00+09:00",
"currentBalance": 5000,
"payableBalance": 5000,
"previousDayBalance": 8000,
"lastMonthBalance": 9000
},
{
"tenantId": "1214732595705114600",
"inquiryResult": "1",
"failReason": "ユーザによってABS側の残高照会権限を解除されている",
"saasCode": "ABS",
"identificationNumber": "2024081201234562",
"bankCode": "0000",
"branchCode": "092",
"accountType": "1",
"accountNumber": "1234567",
"accountName": "XXXXXXXXXX",
"baseDate": "2024-02-06",
"baseTime": "16:02:00+09:00",
"currentBalance": 5000,
"payableBalance": 5000,
"previousDayBalance": 8000,
"lastMonthBalance": 9000
},
{
"tenantId": "1214732595705114600",
"inquiryResult": "1",
"failReason": "ユーザによってABS側の残高照会権限を解除されている",
"saasCode": "ABS",
"identificationNumber": "2024081201234563",
"bankCode": "0000",
"branchCode": "093",
"accountType": "1",
"accountNumber": "1234567",
"accountName": "XXXXXXXXXX",
"baseDate": "2024-02-06",
"baseTime": "16:02:00+09:00",
"currentBalance": 5000,
"payableBalance": 5000,
"previousDayBalance": 8000,
"lastMonthBalance": 9000
},
{
"tenantId": "1214732595705114600",
"inquiryResult": "1",
"failReason": "ユーザによってABS側の残高照会権限を解除されている",
"saasCode": "MT",
"identificationNumber": "20240812012345614",
"bankName": "XXXXX",
"branchCode": "094",
"accountType": "1",
"accountNumber": "1234567",
"accountName": "XXXXXXXXXX",
"baseDate": "2024-02-06",
"baseTime": "16:02:00+09:00",
"currentBalance": 5000,
"payableBalance": 5000,
"previousDayBalance": 8000,
"lastMonthBalance": 9000
}
]
}
リクエスト項目
口座残高情報リスト
項目 | タイプ | 必須 | キー | 制限 | 説明 |
---|---|---|---|---|---|
accountBalanceDatas | accountBalanceData[] | 口座残高情報リスト |
accountBalanceData
項目 | タイプ | 必須 | キー | 制限 | 説明 |
---|---|---|---|---|---|
tenantId | String | ○ | 固定19文字 | テナントID | |
inquiryResult | String | ○ | 固定1文字 | 照会結果 1:照会成功 2:照会失敗 | |
failReason | String | 最大200文字 | 失敗理由 | ||
saasCode | String | ○ | 最大5文字 | Saasコード ABS:AnserBizSOL MT:MoneyTree | |
identificationNumber | String | ○ | ○ | 固定16文字 | 口座残高識別番号 |
bankCode | String | 固定4文字 | 銀行コード | ||
bankName | String | 最大50文字 | 銀行名称 | ||
branchCode | String | ○ | 固定3文字 | 支店コード | |
accountType | String | ○ | 最大2文字 | 預金種目タイプ 1:普通預金 2:当座預金 4:貯蓄預金 9:その他 | |
accountNumber | String | ○ | 最大12文字 | 口座番号 | |
accountName | String | 最大48文字 | 連絡先名 | ||
baseDate | Date | format:YYYY-MM-DD | 基準日 | ||
baseTime | Date | format:hh:mm:ss+09:00 | 基準時刻 | ||
currentBalance | Number | 最大14文字 | 現在残高 | ||
payableBalance | Number | 最大14文字 | 支払可能残高 | ||
previousDayBalance | Number | 最大14文字 | 前日残高 | ||
lastMonthBalance | Number | 最大14文字 | 前月末残高 |
OpenAPIリターン例
{
"total": 4,
"success": 2,
"failure": 2,
"successDatas": [ {
"identificationNumber": "2024081201234561"
}, {
"identificationNumber": "2024081201234562"
}
],
"errorDatas": [ {
"identificationNumber": "2024081201234563",
"errorCode": "XXXXX",
"errorMessage": "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
}, {
"identificationNumber": "2024081201234564",
"errorCode": "XXXXX",
"errorMessage": "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
]
}
項目説明
項目 | タイプ | 説明 |
---|---|---|
total | String | 総件数 |
success | String | 成功件数 |
failure | String | 失敗件数 |
successDatas | successData[] | 成功リスト |
errorDatas | errorData[] | 失敗リスト |
successData
項目 | タイプ | 説明 |
---|---|---|
identificationNumber | String | 口座残高識別番号 |
errorData
項目 | タイプ | 説明 |
---|---|---|
identificationNumber | String | 口座残高識別番号 |
errorCode | String | エラーメッセージコードを返す |
errorMessage | String | エラーメッセージ内容を返す |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
120003 | パラメータ:{0}は指定必須の項目です | |
0013 | パラメータ:{0}は{1}文字以内で指定してください | |
spd.26048.003 | パラメータ:{0}は半角数字で指定してください | |
0010 | パラメータ {0} のフォーマットが不正です。 | |
spd.34242.001 | パラメータ:{0}は{1}数字で指定してください | |
spd.34242.002 | 照会結果が不正です | |
spd.34242.003 | Saasコードが不正です | |
spd.34242.004 | テナントIDが存在しません | |
spd.34242.005 | 口座番号が存在しません | |
spd.34242.006 | 預金種目タイプが不正です | |
spd.34242.007 | 口座残高識別番号:{0}が既に存在します | |
spd.34242.009 | 銀行名称が銀行マスタに存在しません | |
spd.34242.010 | パラメータ:{0}、{1}はいずれかを指定してください |