銀行情報取得

OpenAPI説明

当該APIは銀行情報の取得に利用します。

リクエストURI

  • /api/openapi/bank/info?bankCode=xxxx&branchBankCode=xxx

リクエスト形式

GET

リクエストパラメータ説明

項目名 タイプ 必須 説明
bankCode String 銀行コード
bankBranchCode String 支店コード

OpenAPIリターン例

成功例

{
  "bankInfo": {
    "countryCode": "",
    "bankCode": "",
    "bankType": "",
    "bankName": "",
    "effectiveDateFrom": "",
    "effectiveDateTo": "",
    "bankShortname": "",
    "bankFbname": "",
    "isEnabled": false
  },
  "branchBankInfo": {
    "branchBankCode": "",
    "bankType": "",
    "branchBankName": "",
    "effectiveDateFrom": "",
    "effectiveDateTo": "",
    "branchBankShortname": "",
    "branchBankFbname": "",
    "isEnabled": false
  }
}

失敗例

{
    "message": "ユーザの権限がない",
    "errorCode": "5001"
}

項目説明

bankInfo

項目名称 イプ 説明
bankCode String 銀行コード
bankName String 銀行名称
countryCode UUID 国コード
effectiveDateFrom String 有効開始日
effectiveDateTo String 有効終了日
bankShortName String 銀行略称
bankFbName String 銀行名称(FB用)
isEnabled Boolean ステータス(有効,無効)
bankType String ソース(gengeral,custom)

branchBankInfo

項目名称 イプ 説明
branchBankCode String 支店コード
branchBankName String 支店名称
effectiveDateFrom String 有効開始日
effectiveDateTo String 有効終了日
branchBankShortName String 支店略称
branchBankFbName String 支店名称(FB用)
isEnabled Boolean ステータス(有効,無効)
bankType String ソース(gengeral,custom)

エラーコード説明

errorCode message 説明
5001 ユーザの権限がない
spd.3398.001 銀行コードは空白してはいけません