口座_v2

配信登録

Endpoints

production

development

https://developer.api.bk.mufg.jp

Custom Gateway API Endpoint

パス

/

サマリー

口座情報照会

説明

以下の方法により当APIを試行することが可能です。
　①当画面でのボタン操作による呼び出し
　②開発者の皆さまにご用意いただいたアプリやツールからの呼び出し

※当API試行環境において、認証・認可スキームは実装しておりません。
※アクセス先は、画面右側（黒背景）に記載の「要求の例」をご確認ください。
※当画面でAPIを試行する際、下記「定義」の仕様説明をご確認の上、リクエスト本文を編集してください。
※後述の「添付ファイル」は、「利用コース」→「個人API体験コース」の画面にてご確認ください。

概要
　リソースオーナー単位で口座情報の取得を行います。

1) 照会可能な情報

　リソースオーナー単位で、サービス指定口座に登録された当行の本支店口座のみ照会できます。
　照会可能な情報は口座一覧に加えて、口座残高、NISA情報などとなります。
　体験コースで参照可能なデータについては、添付ファイル「テスト用ダミーデータ一覧」をご参照ください。

2) 照会可能な口座・科目

　円流動性預金（普通・当座・カードローン）・円定期預金・外貨預金・投資信託　です。

セキュリティー

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

クライアントID

API利用事業者を識別するＩＤ

header で必須

string

36桁以内

[備考]　X-IBM-Client-Id: （クライアントID文字列）

パラメーター

X-BTMU-Seq-No

header で必須

string

シーケンスNo
API実行を一意に識別できるNo
Nullデータ指定不可
YYYYMMDD-[16桁の英数字(*1)] (*1)YYYYMMDD内で、重複しない値

{
    "minLength": 25,
    "maxLength": 25
}

header でオプション

string

アプリケーションメディアタイプ
利用可能なデータ形式
Nullデータ指定不可
省略可能。設定する場合は「application/json」または「*/*」のいずれかを指定してください。

応答

200

正常終了
レスポンス内容は、口座オブジェクトをご参照ください。
口座オブジェクト_AccountResponse
Nullデータの返却なし

AccountResponse

default

異常終了
エラーレスポンスオブジェクト_ErrorResponse
Nullデータの返却なし

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/

ヘッダー

X-BTMU-Seq-No

要求

レスポンス

/{account_id}/term-deposits

サマリー

定期預金明細照会

説明

概要
　指定された口座の定期預金明細照会を行います。

1) 照会可能な内容

　ダイレクトでサービス指定口座として登録された定期預金口座の明細を照会します。
　照会できる明細の最大件数は998件です。
　体験コースで参照可能なデータについては、添付ファイル「テスト用ダミーデータ一覧」をご参照ください。

2) 照会できる科目

　定期預金のみ照会可能です。

セキュリティー

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

クライアントID

API利用事業者を識別するＩＤ

header で必須

string

36桁以内

[備考]　X-IBM-Client-Id: （クライアントID文字列）

パラメーター

X-BTMU-Seq-No

header で必須

string

シーケンスNo
API実行を一意に識別できるNo
Nullデータ指定不可
YYYYMMDD-[16桁の英数字(*1)] (*1)YYYYMMDD内で、重複しない値

{
    "minLength": 25,
    "maxLength": 25
}

header でオプション

string

account_id

path で必須

string

口座ID
口座情報を特定する情報
口座情報照会の呼び出しにて取得した口座IDを設定する
Nullデータ指定不可
999999999999形式
店番(3桁) + 科目コード(2桁) + 口座番号(7桁)

{
    "minLength": 12,
    "maxLength": 12
}

応答

200

正常終了
レスポンス内容は、定期預金レスポンスオブジェクトをご参照ください。
定期預金レスポンスオブジェクト_TermDepositResponse
Nullデータの返却なし

TermDepositResponse

default

異常終了
エラーレスポンスオブジェクト_ErrorResponse
Nullデータの返却なし

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/term-deposits

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/term-deposits

ヘッダー

X-BTMU-Seq-No

パラメーター

account_id

要求

レスポンス

/{account_id}/transactions

サマリー

入出金明細照会

説明

概要
指定された円流動性口座（Eco通帳含む）に紐づく入出金明細照会を行います。

1) 照会可能な内容

　ダイレクトでサービス指定口座として登録された、当行の本支店口座のみ指定できます。
　当座預金及び普通預金の異動明細（Eco通帳履歴含む）を照会します。
　体験コースで参照可能なデータについては、添付ファイル「テスト用ダミーデータ一覧」をご参照ください。

2) 照会できる科目

　当座預金及び普通預金です。

3) 照会の単位

　１口座のみ照会ができます。
　複数の口座を、一括して照会することはできません。

4) 照会できる期間

　指定できる期間は、Eco通帳契約口座の場合※、24ヶ月前の1日から照会当日（当APIを実行する日）まで、
　非Eco通帳契約口座の場合、前月の1日から照会当日（当APIを実行する日）までとなります。
　Eco通帳ご契約月の前月月初以降の明細が参照可能であり、契約の前々月以前に遡って明細を参照することはできません。
※備考 - 1) Eco通帳契約口座照会時の注意事項をご参照ください。

5) ページング

　・1回のリクエストで照会できる明細は、最大100件です。
　・101件以上の明細がある場合は、次明細の有無情報と、次回リクエスト時に必要となるキーワード（以下、次明細取得キーワード）をレスポンス情報として返却します。
　・2ページ目以降を照会する際は、口座ID・照会期間(FROM)・照会期間(TO)は前回のリクエストを同じ値を、次明細取得キーワードは前回のレスポンスと同じ値を指定してください。
　値に誤りがあると次の明細が正常に取得できない場合があります。

例

初回のリクエスト

日本語名	英字名	設定値
口座ID	accountId	00111234567　→①2回目のリクエストへそのまま値を入力
照会期間(FROM)	inquiryDateFrom	"2017-01-01"　 →②2回目のリクエストへそのまま値を入力
照会期間(TO)	inquiryDateTo	"2017-08-25"　 →③2回目のリクエストへそのまま値を入力
次明細取得キーワード	nextKeyword	なし

初回のレスポンス（次明細あり）

日本語名	英字名	返却値
次明細有フラグ	nextFlag	"1"：次明細あり
次明細取得キーワード	nextKeyword	"02016102020161020000202"　 →④2回目のリクエストへそのまま値を入力
件数	number	100
返却明細期間(FROM)	transactionDateFrom	"2017-01-01"
返却明細期間(TO)	transactionDateTo	"2017-05-01"
異動明細番号(1明細目)	transactionIdFirst	1
異動明細番号(最終明細)	transactionIdLast	100
以下、省略

2回目のリクエスト（次明細の取得リクエスト）

日本語名	英字名	設定値
口座ID	accountId	00111234567　 ←①1回目のリクエストの値をそのまま入力
照会期間(FROM)	inquiryDateFrom	"2017-01-01"　 ←②1回目のリクエストの値をそのまま入力
照会期間(TO)	inquiryDateTo	"2017-08-25"　 ←③1回目のリクエストの値をそのまま入力
次明細取得キーワード	nextKeyword	02016102020161020000202　 ←④1回目のレスポンスの値をそのまま入力

2回目のレスポンス（次明細なし）

日本語名	英字名	返却値
次明細有フラグ	nextFlag	"0"：次明細なし
次明細取得キーワード	nextKeyword
件数	number	50
返却明細期間(FROM)	transactionDateFrom	"2017-05-01"
返却明細期間(TO)	transactionDateTo	"2017-08-25"
異動明細番号(1明細目)	transactionIdFirst	101
異動明細番号(最終明細)	transactionIdLast	150
以下、省略

備考

1) Eco通帳契約口座照会時の注意事項

　・前月月初以前を照会期間(FROM)としている場合、Eco通帳障害中は取引中断エラーとなります。
　・前月月初以降を照会期間(FROM)としている場合、Eco通帳契約口座であってもメモ欄の表示がされません。

セキュリティー

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

クライアントID

API利用事業者を識別するＩＤ

header で必須

string

36桁以内

[備考]　X-IBM-Client-Id: （クライアントID文字列）

パラメーター

X-BTMU-Seq-No

header で必須

string

シーケンスNo
API実行を一意に識別できるNo
Nullデータ指定不可
YYYYMMDD-[16桁の英数字(*1)] (*1)YYYYMMDD内で、重複しない値

{
    "minLength": 25,
    "maxLength": 25
}

header でオプション

string

account_id

path で必須

string

口座ID
口座情報を特定する情報
口座情報照会APIの呼び出しにて取得した口座IDを設定する
Nullデータ指定不可
999999999999形式
店番(3桁) + 科目コード(2桁) + 口座番号(7桁)

{
    "minLength": 12,
    "maxLength": 12
}

inquiryDateFrom

query で必須

string

照会期間(FROM)
Nullデータ指定不可
YYYY-MM-DD形式

{
    "minLength": 10,
    "maxLength": 10
}

inquiryDateTo

query で必須

string

照会期間(TO)
Nullデータ指定不可
YYYY-MM-DD形式

{
    "minLength": 10,
    "maxLength": 10
}

nextKeyword

query でオプション

string

次明細取得キーワード
Nullデータ指定なし
99999999999999999999999形式
続きの明細を取得する場合に値を指定する。

{
    "minLength": 23,
    "maxLength": 23
}

応答

200

正常終了
レスポンス内容は、入出金明細照会レスポンスオブジェクトをご参照ください。
入出金明細照会レスポンスオブジェクト_TransactionResponse
Nullデータの返却なし

TransactionResponse

default

異常終了
エラーレスポンスオブジェクト_ErrorResponse
Nullデータの返却なし

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/transactions

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/transactions

ヘッダー

X-BTMU-Seq-No

パラメーター

account_id

inquiryDateFrom

inquiryDateTo

nextKeyword

要求

レスポンス

定義

AccountResponse

口座レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
口座配列	accounts	口座配列_Account	なし	口座情報が以下の順で出力する。同一科目が複数件存在する場合、コントローラーから取得した順番をそのまま設定する。口座情報（円流動性）口座情報（円固定性）口座情報（外貨）口座情報（投資信託）

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/Account"
    }
}

Account

口座配列

日本語名	英字名	説明	Nullデータ	備考
口座ID	accountId	口座情報を特定する情報	なし	999999999999形式店番3桁＋科目コード＋口座番号
店番	branchNo	サービス指定口座の店番	なし	999形式
店名	branchName	店名	なし	全角
科目コード	accountTypeCode	科目コード	なし	99形式 00:普通(貯蓄/マイカード/BCL) 01:当座(当座カードローン) 02:定期 38:外貨 28:投資信託
科目詳細コード	accountTypeDetailCode	預金種類、貯蓄フラグ、口座商品詳細コードを連結する項目	なし	99999形式預金種類(2桁)＋貯蓄フラグ(1桁)＋口座商品詳細コード(2桁) 詳細は別紙「別紙02-個人04_照会可能科目一覧」ご参照
科目名	accountTypeName	科目名	なし	全角
口座番号	accountNo	サービス指定口座の口座番号	なし	9999999形式
口座名義	accountName	円流動性口座の口座名義（漢字）	(*1)	全角／半角円流動性口座の場合、口座名義を設定する
代表口座フラグ	primaryAccountFlag	代表口座フラグ	なし	9形式外貨口座の場合、0を設定する 0:代表口座以外 1:代表口座
Eco通帳フラグ	ecoPassBookFlag	Eco通帳契約の有無	(*1)	9形式 1:Eco通帳契約先 Null:Eco通帳未契約先
Eco通帳開設日	ecoPassBookOpeningDate	Eco通帳開設日	(*1)	YYYY-MM-DD形式 Eco通帳フラグが1の場合、Eco通帳開設日を設定する。 Eco通帳契約先であってもEco通帳開設手続中の場合などではNullを設定する。
通貨コード	currencyCode	通貨略称	なし	半角外貨口座の場合、通貨略名を設定する上記以外の場合、"JPY"を設定する
残高	balance	残高	(*1)	ZZZZZZZZZZZZ9形式または -ZZZZZZZZZZZ9形式円流動性または円固定性口座の場合、該当項目を設定する
引出可能額	withdrawableAmount	引出可能額	(*1)	ZZZZZZZZZZZZ9形式円流動性口座の場合、該当項目を設定する
外貨額	foreignCurrencyBalance	外貨口座の口座残高（外貨）	(*1)	ZZZZZZZZZZZ9.99形式または -ZZZZZZZZZZZ9.99形式外貨口座の場合、該当項目を設定する
円換算額	yenEquivalent	外貨口座の口座残高（円換算）	(*1)	ZZZZZZZZZZZZZZZZZ9形式または -ZZZZZZZZZZZZZZZZ9形式外貨口座の場合、算出した円換算額を設定する
為替レート	exchangeRate	為替レート	(*1)	ZZZZ9.99形式外貨口座の場合、算出した適用レート（TTB）を設定する
口座種別	accountType	投資信託口座の預り区分	(*1)	9形式投資信託口座の場合、預り区分を判定した値を設定する 1:一般口座 2:特定口座/源泉徴収あり 3:特定口座/源泉徴収なし
成人NISAフラグ	seniorNisaFlag	成人NISA種別	(*1)	9形式投資信託口座の場合、成人NISA種別を判定した値を設定する 0:未使用 1:NISA利用 2:つみたてNISA利用
時価評価額合計	totalMarketValue	投資信託口座の時価評価額合計	(*1)	ZZZZZZZZZZZZZZZ9形式投資信託口座の場合、時価評価額円貨を合算した値を設定する（保有ファンドが0件の場合は0を設定する）
評価損益合計	totalUnrealizedProfitAndLoss	投資信託口座の評価損益合計	(*1)	ZZZZZZZZZZZZZZZ9形式または -ZZZZZZZZZZZZZZZ9形式投資信託口座の場合、評価損益円貨を合算した値を設定する（保有ファンドが0件の場合は0を設定する）
基準日	baseDate	保有ファンド基準日	(*1)	YYYY-MM-DD形式投資信託口座の場合、該当項目を設定する

(*1)NULLの場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "口座情報を特定する情報",
            "type": "string",
            "example": "123121234567",
            "minLength": 12,
            "maxLength": 12
        },
        "branchNo": {
            "description": "サービス指定口座の店番",
            "type": "string",
            "example": "001",
            "minLength": 3,
            "maxLength": 3
        },
        "branchName": {
            "description": "店名",
            "type": "string",
            "example": "本店",
            "minLength": 1,
            "maxLength": 30
        },
        "accountTypeCode": {
            "description": "科目コード",
            "type": "string",
            "example": "02",
            "minLength": 2,
            "maxLength": 2
        },
        "accountTypeDetailCode": {
            "description": "預金種類、貯蓄フラグ、口座商品詳細コードを連結する項目",
            "type": "string",
            "example": "00000",
            "minLength": 5,
            "maxLength": 5
        },
        "accountTypeName": {
            "description": "科目名",
            "type": "string",
            "example": "当座",
            "minLength": 1,
            "maxLength": 32
        },
        "accountNo": {
            "description": "サービス指定口座の口座番号",
            "type": "string",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "accountName": {
            "description": "円流動性口座の口座名義（漢字）",
            "type": "string",
            "example": "エジソン商事",
            "minLength": 0,
            "maxLength": 50
        },
        "primaryAccountFlag": {
            "description": "代表口座フラグ",
            "type": "integer",
            "format": "int32",
            "example": 0,
            "minimum": 0,
            "maximum": 9
        },
        "ecoPassBookFlag": {
            "description": "Eco通帳契約の有無",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "minimum": 0,
            "maximum": 9
        },
        "ecoPassBookOpeningDate": {
            "description": "Eco通帳開設日",
            "type": "string",
            "example": "2020-03-03",
            "minLength": 10,
            "maxLength": 10
        },
        "currencyCode": {
            "description": "通貨略称",
            "type": "string",
            "example": "USD",
            "minLength": 3,
            "maxLength": 3
        },
        "balance": {
            "description": "残高",
            "type": "integer",
            "format": "int64",
            "example": 9999999999999,
            "minimum": -999999999999,
            "maximum": 9999999999999
        },
        "withdrawableAmount": {
            "description": "引出可能額",
            "type": "integer",
            "format": "int64",
            "example": 9999999999999,
            "minimum": 0,
            "maximum": 9999999999999
        },
        "foreignCurrencyBalance": {
            "description": "外貨口座の口座残高（外貨）",
            "type": "string",
            "example": "8000000000000000",
            "minLength": 4,
            "maxLength": 16
        },
        "yenEquivalent": {
            "description": "外貨口座の口座残高（円換算）",
            "type": "string",
            "example": "800000000000000000",
            "minLength": 1,
            "maxLength": 18
        },
        "exchangeRate": {
            "description": "為替レート",
            "type": "string",
            "example": "99999.99",
            "minLength": 4,
            "maxLength": 8
        },
        "accountType": {
            "description": "投資信託口座の預り区分",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "minimum": 0,
            "maximum": 9
        },
        "seniorNisaFlag": {
            "description": "成人NISA種別",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "minimum": 0,
            "maximum": 9
        },
        "totalMarketValue": {
            "description": "投資信託口座の時価評価額合計",
            "type": "integer",
            "format": "int64",
            "example": 8000000000000000,
            "minimum": 0,
            "maximum": 9007199254740992
        },
        "totalUnrealizedProfitAndLoss": {
            "description": "投資信託口座の評価損益合計",
            "type": "integer",
            "format": "int64",
            "example": 8000000000000000,
            "minimum": -9007199254740992,
            "maximum": 9007199254740992
        },
        "baseDate": {
            "description": "保有ファンド基準日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        }
    },
    "additionalProperties": false
}

TermDepositResponse

定期預金レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
件数	numberOfTermDepositDetails	預金明細取得件数	なし	ZZ9形式
操作日	operationDate	システム日付（年月日）	なし	YYYY-MM-DD形式
操作時刻	operationTime	システム日付（時分秒）	なし	HH:MM:SS形式
定期預金口座オブジェクト	termDepositAccount	定期預金口座オブジェクト_TermDepositAccount	なし	以下の「定期預金口座オブジェクト　TermDepositAccount」参照
定期預金明細配列	termDepositDetails	定期預金明細配列_TermDepositDetail	(*1)	以下の「定期預金明細配列　TermDepositDetail」参照

(*1)NULLの場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "numberOfTermDepositDetails": {
            "description": "預金明細取得件数",
            "type": "integer",
            "format": "int32",
            "example": 999,
            "minimum": 0,
            "maximum": 999
        },
        "operationDate": {
            "description": "システム日付（年月日）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "operationTime": {
            "description": "システム日付（時分秒）",
            "type": "string",
            "example": "01:23:04",
            "minLength": 8,
            "maxLength": 8
        },
        "termDepositAccount": {
            "description": "定期預金口座オブジェクト_TermDepositAccount",
            "$ref": "#\/definitions\/TermDepositAccount",
            "example": ""
        },
        "termDepositDetails": {
            "description": "定期預金明細配列_TermDepositDetail",
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/TermDepositDetail"
            },
            "example": ""
        }
    },
    "additionalProperties": false
}

TermDepositAccount

定期預金口座オブジェクト

日本語名	英字名	説明	Nullデータ	備考
店番	branchNo	サービス指定口座の店番	なし	999形式
店名	branchName	店名	なし	全角
科目コード	accountTypeCode	科目コード	なし	99形式固定値:02（定期）
科目詳細コード	accountTypeDetailCode	預金種類、貯蓄フラグ、口座商品詳細コードを連結する項目	なし	99999形式預金種類(2桁)＋貯蓄フラグ(1桁)＋口座商品詳細コード(2桁) 詳細は別紙「別紙02-個人04_照会可能科目一覧」ご参照
科目名	accountTypeName	科目名	なし	全角
口座番号	accountNo	サービス指定口座の口座番号	なし	9999999形式
税区分	taxType	税区分	なし	全角 ■返却値マル優、一般財形、住宅財形、総合課税、年金財形、非課税、分離課税
預入金額合計	totalAmount	お預かり金額合計	なし	ZZZZZZZZZZZ9形式

{
    "type": "object",
    "properties": {
        "branchNo": {
            "description": "サービス指定口座の店番",
            "type": "string",
            "example": "001",
            "minLength": 3,
            "maxLength": 3
        },
        "branchName": {
            "description": "店名",
            "type": "string",
            "example": "本店",
            "minLength": 1,
            "maxLength": 30
        },
        "accountTypeCode": {
            "description": "科目コード",
            "type": "string",
            "example": "02",
            "minLength": 2,
            "maxLength": 2
        },
        "accountTypeDetailCode": {
            "description": "預金種類、貯蓄フラグ、口座商品詳細コードを連結する項目",
            "type": "string",
            "example": "00001",
            "minLength": 5,
            "maxLength": 5
        },
        "accountTypeName": {
            "description": "科目名",
            "type": "string",
            "example": "定期",
            "minLength": 1,
            "maxLength": 32
        },
        "accountNo": {
            "description": "サービス指定口座の口座番号",
            "type": "string",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "taxType": {
            "description": "税区分",
            "type": "string",
            "example": "総合課税",
            "minLength": 1,
            "maxLength": 10
        },
        "totalAmount": {
            "description": "お預かり金額合計",
            "type": "integer",
            "format": "int64",
            "example": 800000,
            "minimum": 0,
            "maximum": 999999999999
        }
    },
    "additionalProperties": false
}

TermDepositDetail

定期預金明細配列

日本語名	英字名	説明	Nullデータ	備考
預金番号	depositNo	預金番号	なし	999形式
定期種類	termDepositType	定期種類	なし	全角／半角 ■返却値ＭＭＣ、プレミア、特別定期、日の出定期、インターネット定期、期日指定定期、据置定期（スーパーNo.１）、スーパーＭＭＣ、変動金利定期、大口定期、スーパー定期、スーパー定期３００、特約付預金、規制定期、定期
預入日	depositDate	預入日	なし	YYYY-MM-DD形式
満期日	maturityDate	満期日	なし	YYYY-MM-DD形式
期間	depositPeriod	期間	なし	全角／半角 ■返却値期日指定、1ヵ月、2ヵ月、3ヵ月、6ヵ月、1年、2年、2年複利、3年、3年複利、4年、4年複利、5年、5年複利、6年、6年複利、7年、7年複利、8年、8年複利、9年、9年複利、10年、10年複利、9999日、据置定期
金額	amount	金額	なし	ZZZZZZZZZZZ9形式
利率	interestRate	利率	なし	Z9.999形式または"****" 定期種類が特約付預金の場合のみ「****」となる。
満期日取扱	maturityDateHandling	満期日取扱	なし	全角 ■返却値非継続、継続、分割、元金成長、利息受取、自動解約

{
    "type": "object",
    "properties": {
        "depositNo": {
            "description": "預金番号",
            "type": "string",
            "example": "002",
            "minLength": 3,
            "maxLength": 3
        },
        "termDepositType": {
            "description": "定期種類",
            "type": "string",
            "example": "据置定期（スーパーNo.１）",
            "minLength": 1,
            "maxLength": 14
        },
        "depositDate": {
            "description": "預入日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "maturityDate": {
            "description": "満期日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "depositPeriod": {
            "description": "期間",
            "type": "string",
            "example": "期日指定",
            "minLength": 1,
            "maxLength": 14
        },
        "amount": {
            "description": "金額",
            "type": "integer",
            "format": "int64",
            "example": 600000000000,
            "minimum": 0,
            "maximum": 999999999999
        },
        "interestRate": {
            "description": "利率",
            "type": "string",
            "example": "20.408",
            "minLength": 5,
            "maxLength": 6
        },
        "maturityDateHandling": {
            "description": "満期日取扱",
            "type": "string",
            "example": "非継続",
            "minLength": 1,
            "maxLength": 12
        }
    },
    "additionalProperties": false
}

TransactionResponse

入出金明細レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
次明細有フラグ	nextFlag	次明細有フラグ	なし	9形式照会条件に合致して返却されていない明細が残っている場合、"1"（あり）を設定する。上記以外の場合、"0"（なし）を設定する。
次明細取得キーワード	nextKeyword	次明細取得キーワード	(*1)	99999999999999999999999形式次明細有フラグが"1"（あり）の場合、設定する。
件数	number	明細取得件数	なし	ZZ9形式
返却明細期間（FROM）	transactionDateFrom	返却した先頭明細の取引日	(*1)	YYYY-MM-DD形式明細取得件数が0件の場合、NULLを設定。
返却明細期間（TO）	transactionDateTo	返却した最終明細の取引日	(*1)	YYYY-MM-DD形式明細取得件数が0件の場合、NULLを設定。
異動明細番号（1明細目）	transactionIdFirst	異動明細番号(1明細目)	(*1)	ZZZZ9形式明細取得件数が0件の場合、NULLを設定。
異動明細番号（最終明細）	transactionIdLast	異動明細番号(最終明細)	(*1)	ZZZZ9形式明細取得件数が0件の場合、NULLを設定。
操作日	operationDate	操作日	なし	YYYY-MM-DD形式
操作時刻	operationTime	操作時刻	なし	HH:MM:SS形式
口座情報オブジェクト	accountInfo	口座情報オブジェクト_AccountInfo	なし	以下の「口座情報オブジェクト　AccountInfo」参照
入出金明細配列	transactions	入出金明細配列_Transaction	(*1)	以下の「入出金明細配列　Transaction」参照出力対象の情報が存在しない場合、NULLを設定。

(*1)NULLの場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "nextFlag": {
            "description": "次明細有フラグ",
            "type": "string",
            "example": "1",
            "minLength": 1,
            "maxLength": 1
        },
        "nextKeyword": {
            "description": "次明細取得キーワード",
            "type": "string",
            "example": "10000000020161020000111",
            "minLength": 23,
            "maxLength": 23
        },
        "number": {
            "description": "明細取得件数",
            "type": "integer",
            "example": 999,
            "format": "int32",
            "minimum": 0,
            "maximum": 999
        },
        "transactionDateFrom": {
            "description": "返却した先頭明細の取引日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionDateTo": {
            "description": "返却した最終明細の取引日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionIdFirst": {
            "description": "異動明細番号(1明細目)",
            "type": "string",
            "example": "234",
            "minLength": 1,
            "maxLength": 5
        },
        "transactionIdLast": {
            "description": "異動明細番号(最終明細)",
            "type": "string",
            "example": "234",
            "minLength": 1,
            "maxLength": 5
        },
        "operationDate": {
            "description": "操作日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "operationTime": {
            "description": "操作時刻",
            "type": "string",
            "example": "01:23:04",
            "minLength": 8,
            "maxLength": 8
        },
        "accountInfo": {
            "description": "口座情報オブジェクト_AccountInfo",
            "$ref": "#\/definitions\/AccountInfo",
            "example": ""
        },
        "transactions": {
            "description": "入出金明細配列_Transaction",
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Transaction"
            },
            "example": ""
        }
    },
    "additionalProperties": false
}

AccountInfo

口座情報オブジェクト

日本語名	英字名	説明	Nullデータ	備考
店番	branchNo	店番	なし	999形式
店名	branchName	店名	なし	全角店名＋店舗形態（支店/出張所など）
科目コード	accountTypeCode	科目コード	なし	99形式 00:普通(貯蓄/マイカード/BCL) 01:当座(当座カードローン) 02:定期 38:外貨 28:投資信託
科目詳細コード	accountTypeDetailCode	科目情報を特定する情報	なし	99999形式預金種類(2桁)＋貯蓄フラグ(1桁)＋口座商品詳細コード(2桁) ■返却値詳細は別紙「別紙02-個人04_照会可能科目一覧」ご参照
科目名	accountTypeName	科目名	なし	全角
口座番号	accountNo	口座番号	なし	9999999形式
口座名義	accountName	円流動性口座の口座名義	(*1)	全角／半角円流動性口座の場合、口座名義を設定する
通貨コード	currencyCode	通貨コード	なし	固定値："JPY"

(*1)NULLの場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "branchNo": {
            "description": "店番",
            "type": "string",
            "example": "123",
            "minLength": 3,
            "maxLength": 3
        },
        "branchName": {
            "description": "店名",
            "type": "string",
            "example": "渋谷中央",
            "minLength": 1,
            "maxLength": 30
        },
        "accountTypeCode": {
            "description": "科目コード",
            "type": "string",
            "example": "02",
            "minLength": 2,
            "maxLength": 2
        },
        "accountTypeDetailCode": {
            "description": "科目情報を特定する情報",
            "type": "string",
            "example": "99999",
            "minLength": 5,
            "maxLength": 5
        },
        "accountTypeName": {
            "description": "科目名",
            "type": "string",
            "example": "当座",
            "minLength": 1,
            "maxLength": 32
        },
        "accountNo": {
            "description": "口座番号",
            "type": "string",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "accountName": {
            "description": "円流動性口座の口座名義",
            "type": "string",
            "example": "エジソン商事",
            "minLength": 0,
            "maxLength": 50
        },
        "currencyCode": {
            "description": "通貨コード",
            "type": "string",
            "example": "JPY",
            "minLength": 3,
            "maxLength": 3
        }
    },
    "additionalProperties": false
}

Transaction

入出金明細配列

日本語名	英字名	説明	Nullデータ	備考
取引日（勘定日）	settlementDate	取引日（勘定日）	なし	YYYY-MM-DD形式
取引指定日（起算日）	valueDate	取引指定日（起算日）	なし	YYYY-MM-DD形式取引指定日（起算日）がNULLまたはブランクの場合、取引日（勘定日）を設定
異動明細番号	transactionId	異動明細番号	なし	ZZZZ9形式
取引区分	transactionType	取引区分	(*1)	全角 ■返却値（例）クレジツト、振替、個人年金、投信購入、手数料、寄付、社員預金、ローン、家賃、水道、ガス、配当、宝くじ、ご返済、カード、など
摘要内容	remarks	摘要内容	(*1)	全角
入払区分コード	debitCreditTypeCode	入払区分コード	(*1)	9形式 1:入金 2:出金預金商品種類を変更した場合、NULLを設定。例えば、通帳から照合表口への変更や還元サイクルの変更が該当する。
金額	amount	入出金金額	なし	ZZZZZZZZZZZ9形式入払区分コードがNULLの場合、0を設定。
差引残高	balance	差引残高	なし	ZZZZZZZZZZZ9形式または -ZZZZZZZZZZZ9形式
メモ	memo	メモ ※Eco通帳契約者のみ利用できるメモ機能	(*1)	全角

(*1)NULLの場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "settlementDate": {
            "description": "取引日（勘定日）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "valueDate": {
            "description": "取引指定日（起算日）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionId": {
            "description": "異動明細番号",
            "type": "string",
            "example": "234",
            "minLength": 1,
            "maxLength": 5
        },
        "transactionType": {
            "description": "取引区分",
            "type": "string",
            "example": "カード",
            "minLength": 1,
            "maxLength": 12
        },
        "remarks": {
            "description": "摘要内容",
            "type": "string",
            "example": "カード",
            "minLength": 1,
            "maxLength": 15
        },
        "debitCreditTypeCode": {
            "description": "入払区分コード",
            "type": "string",
            "example": "1",
            "minLength": 1,
            "maxLength": 1
        },
        "amount": {
            "description": "入出金金額",
            "type": "integer",
            "example": 600000,
            "format": "int64",
            "minimum": 0,
            "maximum": 999999999999
        },
        "balance": {
            "description": "差引残高",
            "type": "integer",
            "example": 800000,
            "format": "int64",
            "minimum": -999999999999,
            "maximum": 9999999999999
        },
        "memo": {
            "description": "メモ
※Eco通帳契約者のみ利用できるメモ機能",
            "type": "string",
            "example": "臨時収入",
            "minLength": 1,
            "maxLength": 7
        }
    }
}

ErrorResponse

エラーレスポンスオブジェクト

日本語名	英字名	説明	Nullデータ
ステータスコード	status	ステータスコード	(*1)
メッセージ	message	ステータスコードに紐づくメッセージ	(*1)
エラーコード	code	エラーコード	(*1)
開発者向け詳細メッセージ	developer_message	開発者向けの詳細メッセージ	(*1)
httpステータスコード	httpCode	httpステータスコードと同値	(*1)
httpステータスメッセージ	httpMessage	httpステータスコードの文字列	(*1)
詳細メッセージ	moreInformation	開発者向けの詳細メッセージ	(*1)
エラー種別	error	エラーの種別を表す文字列	(*1)
詳細メッセージ	error_description	開発者向けの詳細メッセージ	(*1)

(*1)返却データがない場合、キー・値ともに返却しません

{
    "type": "object",
    "properties": {
        "status": {
            "description": "ステータスコード",
            "type": "integer",
            "format": "int32",
            "example": 400,
            "minimum": 100,
            "maximum": 999
        },
        "message": {
            "description": "ステータスコードに紐づくメッセージ",
            "type": "string"
        },
        "code": {
            "description": "エラーコード",
            "type": "string"
        },
        "developer_message": {
            "description": "開発者向けの詳細メッセージ",
            "type": "string"
        },
        "httpCode": {
            "description": "httpステータスコードと同値",
            "type": "string"
        },
        "httpMessage": {
            "description": "httpステータスコードの文字列",
            "type": "string"
        },
        "moreInformation": {
            "description": "開発者向けの詳細メッセージ",
            "type": "string"
        },
        "error": {
            "description": "エラーの種別を表す文字列",
            "type": "string"
        },
        "error_description": {
            "description": "開発者向けの詳細メッセージ",
            "type": "string"
        }
    },
    "additionalProperties": false
}

developer.portal.bk.mufg.jp

メニュー

口座_v2

口座_v2

パス

/

1) 照会可能な情報

2) 照会可能な口座・科目

/{account_id}/term-deposits

1) 照会可能な内容

2) 照会できる科目

/{account_id}/transactions

1) 照会可能な内容

2) 照会できる科目

3) 照会の単位

4) 照会できる期間

5) ページング

1) Eco通帳契約口座照会時の注意事項

定義