production
development
https://developer.api.bk.mufg.jp
Custom Gateway API Endpoint
パス
/
get /
口座情報照会
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Accept
header でオプション
string
200
default
要求の例
応答の例
GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/
この操作を試してみる
/{account_id}/term-deposits
get /{account_id}/term-deposits
定期預金明細照会
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Accept
header でオプション
string
account_id
path で必須
string
{
"minLength": 12,
"maxLength": 12
}default
要求の例
応答の例
GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/term-deposits
この操作を試してみる
/{account_id}/transactions
get /{account_id}/transactions
入出金明細照会
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Accept
header でオプション
string
account_id
path で必須
string
{
"minLength": 12,
"maxLength": 12
}inquiryDateFrom
query で必須
string
{
"minLength": 10,
"maxLength": 10
}inquiryDateTo
query で必須
string
{
"minLength": 10,
"maxLength": 10
}nextKeyword
query でオプション
string
{
"minLength": 23,
"maxLength": 23
}default
要求の例
応答の例
GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v2/me/accounts/{account_id}/transactions
この操作を試してみる
定義
{
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
}
}
{
"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
}