口座

口座

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

Custom Gateway API Endpoint

パス

/{account_id}

/{account_id}/transactions

/{account_id}/transactions/paymentarrivals

定義

口座情報オブジェクト

日本語名英字名説明Nullデータ備考
支店番号branchNo照会した口座の支店番号なし半角数字
支店名branchName照会した口座の支店名なしすべて全角文字
科目コードaccountTypeCode照会した口座の科目コードなし1：普通、2：当座、5：通知、6：定期
※ビジネスカードローン（BCL）の場合は、1：普通
科目名accountTypeName照会した口座の科目名なし”普通”、”当座”、”通知”、”定期”、”BCL”
※ビジネスカードローン（BCL）の場合はBCL
口座番号accountNo照会した口座の口座番号なし半角数字
口座名義（漢字）accountNameKanji照会した口座の口座名義なしすべて全角文字
口座名義（カナ）accountNameKana照会した口座の口座名義なし全角数字、全角英字、全角カナ、許容記号1(※2)
操作日operationDateリクエストを受け付けた日付なしYYYY-MM-DD形式
操作時刻operationTimeリクエストを受け付けた時刻なしHH:MM:SS形式
当日残高todayBalance照会当日の残高なし-999999999999～9999999999999
資金化残高clearedBalance照会当日の資金化残高(※1)-999999999999～9999999999999
前日残高基準日previousDate前日残高の基準日(※1)YYYY-MM-DD形式
前日残高previousDayBalance前日の残高(※1)-999999999999～9999999999999
前月末残高基準日previousMonthEndDate前月末の基準日(※1)YYYY-MM-DD形式
前月末残高previousMonthEndBalance前月末の残高(※1)-999999999999～9999999999999

(※1)照会した口座が定期預金または通知預金の場合、キー・値ともに返却しません。

(※2)￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)の計21文字になります。

　　「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "type": "object",
    "properties": {
        "branchNo": {
            "type": "string",
            "description": "支店番号",
            "example": "123",
            "minLength": 3,
            "maxLength": 3
        },
        "branchName": {
            "type": "string",
            "description": "支店名",
            "example": "渋谷中央",
            "minLength": 1,
            "maxLength": 15
        },
        "accountTypeCode": {
            "type": "string",
            "description": "科目コード（1：普通、2：当座、5：通知、6：定期）",
            "example": 2,
            "minLength": 1,
            "maxLength": 1
        },
        "accountTypeName": {
            "type": "string",
            "description": "科目名",
            "example": "当座",
            "minLength": 1,
            "maxLength": 8
        },
        "accountNo": {
            "type": "string",
            "description": "口座番号",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "accountNameKanji": {
            "description": "口座名義（漢字）",
            "type": "string",
            "example": "エジソン商事",
            "minLength": 1,
            "maxLength": 71
        },
        "accountNameKana": {
            "description": "口座名義（カナ）",
            "type": "string",
            "example": "エジソンショウジ",
            "minLength": 1,
            "maxLength": 71
        },
        "operationDate": {
            "description": "操作日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "operationTime": {
            "description": "操作時刻",
            "type": "string",
            "example": "01:23:40",
            "minLength": 8,
            "maxLength": 8
        },
        "todayBalance": {
            "description": "当日残高",
            "type": "integer",
            "example": 8000000,
            "format": "int64",
            "minimum": -999999999999,
            "maximum": 9999999999999
        },
        "clearedBalance": {
            "description": "資金化残高",
            "type": "integer",
            "example": 8000000,
            "format": "int64",
            "minimum": -999999999999,
            "maximum": 9999999999999
        },
        "previousDate": {
            "description": "前日残高基準日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "previousDayBalance": {
            "description": "前日残高",
            "type": "integer",
            "example": 8000000,
            "format": "int64",
            "minimum": -999999999999,
            "maximum": 9999999999999
        },
        "previousMonthEndDate": {
            "description": "前月末残高基準日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "previousMonthEndBalance": {
            "description": "前月末残高",
            "type": "integer",
            "example": 8000000,
            "format": "int64",
            "minimum": -999999999999,
            "maximum": 9999999999999
        }
    }
}

入出金明細照会／振込入金明細照会レスポンスオブジェクト

日本語名英字名説明Nullデータ備考
次明細有フラグnextFlag次明細の有無なし0：なし、1：あり
次明細取得キーワードnextKeyword明細を続きから取得するために必要な項目。
続きがない場合はnull。		(※1)
件数number明細取得件数なし0～200を返却
返却明細期間(FROM)transactionDateFrom返却した先頭明細の取引日
YYYY-MM-DD形式		(※2)照会期間に対して、
返却する明細期間は必ずしも
照会期間（FROM）と一致しない。
件数がゼロ件の場合、当項目は返却しない。
返却明細期間(TO)transactionDateTo返却した最終明細の取引日
YYYY-MM-DD形式		(※2)照会期間に対して、
返却する明細期間は必ずしも
照会期間（TO）と一致しない
件数がゼロ件の場合、当項目は返却しない。
異動明細番号(1明細目)transactionIdFirst返却した先頭明細の異動明細番号(※2)半角数字 "^(\d{0,6})$"
件数がゼロ件の場合、当項目は返却しない。
異動明細番号(最終明細)transactionIdLast返却した最終明細の異動明細番号(※2)半角数字 "^(\d{0,6})$"
件数がゼロ件の場合、当項目は返却しない。
操作日operationDateリクエストを受け付けた日付
YYYY-MM-DD形式		なし
操作時刻operationTimeリクエストを受け付けた時刻
HH:MM:SS形式		なし
共通口座情報accountInfo共通口座情報オブジェクト_AccountInfoなし
入出金明細配列transactions入出金明細オブジェクト_Transactions　の配列(※2)件数がゼロ件の場合、当項目は返却しない。
入出金明細配列paymentArrivals振込入金明細オブジェクト_PaymentArrival　の配列(※2)件数がゼロ件の場合、当項目は返却しない。

(※1) 次明細照会の指定がない場合、キー・値ともに返却しません。

(※2) 該当項目にて返却するデータがない場合、キー・値ともに返却しません

{
    "properties": {
        "nextFlag": {
            "type": "string",
            "description": "次明細有フラグ",
            "example": "0：なし、1：あり",
            "minLength": 1,
            "maxLength": 1
        },
        "nextKeyword": {
            "type": "string",
            "description": "次明細取得キーワード",
            "example": "02016102020161020000111",
            "minLength": 23,
            "maxLength": 23
        },
        "number": {
            "type": "integer",
            "description": "件数",
            "example": 100,
            "format": "int32",
            "minimum": 0,
            "maximum": 200
        },
        "transactionDateFrom": {
            "type": "string",
            "description": "返却明細期間(FROM)",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionDateTo": {
            "type": "string",
            "description": "返却明細期間(TO)",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionIdFirst": {
            "type": "string",
            "description": "異動明細番号(1明細目)",
            "example": "234",
            "minLength": 1,
            "maxLength": 6
        },
        "transactionIdLast": {
            "type": "string",
            "description": "異動明細番号(最終明細)",
            "example": "234",
            "minLength": 1,
            "maxLength": 6
        },
        "operationDate": {
            "type": "string",
            "description": "操作日",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "operationTime": {
            "type": "string",
            "description": "操作時刻",
            "example": "01:23:04",
            "minLength": 8,
            "maxLength": 8
        },
        "accountInfo": {
            "description": "共通口座情報",
            "$ref": "#\/definitions\/AccountInfo"
        },
        "transactions": {
            "description": "入出金明細配列",
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Transaction"
            }
        },
        "paymentArrivals": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/PaymentArrival"
            },
            "description": "振込入金明細配列"
        }
    },
    "additionalProperties": false
}

共通口座情報オブジェクト

日本語名英字名説明Nullデータ備考
店番branchNo照会した口座の店番なし半角数字 "^(\d{3})$"
店名branchName照会した口座の店名なし全角文字すべて
科目コードaccountTypeCode照会した口座の科目コードなし1：普通、2：当座
※ビジネスカードローン(BCL)は、1:普通
科目名accountTypeName照会した口座の科目名なし"普通"、"当座"、"BCL"
※ビジネスカードローン(BCL)は、""BCL""
口座番号accountNo照会した口座の口座番号なし半角数字 "^(\d{7})$"
口座名義（漢字）accountNameKanji照会した口座の口座名義なし全角文字すべて
口座名義（カナ）accountNameKana照会した口座の口座名義なし全角数字、全角英字、全角カナ、
許容記号１(※3)

(※3) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)の計21文字になります。 「ー、－、―、‐」については、全て「－(ハイフン)」に変換して処理されます。

{
    "properties": {
        "branchNo": {
            "type": "string",
            "description": "店番",
            "example": "123",
            "minLength": 3,
            "maxLength": 3
        },
        "branchName": {
            "type": "string",
            "description": "店名",
            "example": "渋谷中央",
            "minLength": 1,
            "maxLength": 15
        },
        "accountTypeCode": {
            "type": "string",
            "description": "科目コード（1：普通、2：当座）",
            "example": "2",
            "minLength": 1,
            "maxLength": 1
        },
        "accountTypeName": {
            "type": "string",
            "description": "科目名",
            "example": "当座",
            "minLength": 1,
            "maxLength": 8
        },
        "accountNo": {
            "type": "string",
            "description": "口座番号",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "accountNameKanji": {
            "type": "string",
            "description": "口座名義（漢字）",
            "example": "エジソン商事",
            "minLength": 1,
            "maxLength": 71
        },
        "accountNameKana": {
            "type": "string",
            "description": "口座名義（カナ）",
            "example": "エジソンショウジ",
            "minLength": 1,
            "maxLength": 71
        }
    },
    "additionalProperties": false
}

入出金明細オブジェクト

日本語名英字名説明Nullデータ備考
取引日（勘定日）transactionDate取引日なしYYYY-MM-DD形式
取引指定日（起算日）designatedDate指定日なしYYYY-MM-DD形式
異動明細番号transactionId異動明細番号（入出金明細ID）なし半角数字 "^(\d{0,6})$"
取引区分transactionType取引区分なし全角文字すべて
摘要remarks摘要なし全角文字すべて
入払区分コードdebitCreditTypeCode入金、出金を表すコード(※1)1：入金、2：出金
金額amount入金金額(※1)0～999999999999
取引後残高balance取引後の口座残高なし-999999999999～9999999999999

(※1) 入払区分が「その他」の明細の場合、キー・値ともに返却しません。（入払区分コードに「その他」は含まない）

{
    "type": "object",
    "properties": {
        "transactionDate": {
            "description": "取引日（勘定日）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "designatedDate": {
            "description": "取引指定日（起算日）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionId": {
            "description": "異動明細番号",
            "type": "string",
            "example": "234",
            "minLength": 1,
            "maxLength": 6
        },
        "transactionType": {
            "description": "取引区分",
            "type": "string",
            "example": "カード",
            "minLength": 1,
            "maxLength": 10
        },
        "remarks": {
            "description": "摘要",
            "type": "string",
            "example": "カード入金",
            "minLength": 1,
            "maxLength": 22
        },
        "debitCreditTypeCode": {
            "description": "入払区分コード（1：入金、2：出金）",
            "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
        }
    }
}

振込入金明細オブジェクト

日本語名英字名説明Nullデータ備考
取引日（勘定日）transactionDate取引日なしYYYY-MM-DD形式
取引指定日（起算日）designatedDate指定日なしYYYY-MM-DD形式
異動明細番号transactionId異動明細番号（入出金明細ID）なし半角数字 "^(\d{0,6})$"
取引区分transactionType取引区分なし全角文字すべて
依頼人名applicantName依頼人名なし全角文字すべて
金融機関名(カナ)paymentFinancialInstitutionNameKana出金元口座の金融機関なし全角文字すべて
支店名(カナ)branchNameKana出金元口座の支店名なし全角文字すべて
振込依頼人番号paymentApplicantNo出金元の振込依頼人番号(※1)半角数字 "^(\d{0,10})$"
EDI情報ediInfoEDI情報(※1)全角文字すべて
入払区分コードdebitCreditTypeCode入金、出金を表すコード(※2)1：入金、2：出金
金額amount入金金額(※2)0～999999999999

(※1) 該当項目にて返却するデータがない場合、キー・値ともに返却しません

(※2) 入払区分が「その他」の明細の場合、キー・値ともに返却しません。（入払区分コードに「その他」は含まない）

{
    "properties": {
        "transactionDate": {
            "type": "string",
            "description": "取引日（勘定日）",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "designatedDate": {
            "type": "string",
            "description": "取引指定日（起算日）",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "transactionId": {
            "type": "string",
            "description": "異動明細番号",
            "example": "234",
            "minLength": 1,
            "maxLength": 6
        },
        "transactionType": {
            "type": "string",
            "description": "取引区分",
            "example": "カード",
            "minLength": 1,
            "maxLength": 10
        },
        "applicantName": {
            "type": "string",
            "description": "依頼人名",
            "example": "ビズステーションカブシキガイシャ",
            "minLength": 1,
            "maxLength": 50
        },
        "paymentFinancialInstitutionNameKana": {
            "type": "string",
            "description": "金融機関名(カナ)",
            "example": "ミズホギンコウ",
            "minLength": 1,
            "maxLength": 15
        },
        "branchNameKana": {
            "type": "string",
            "description": "支店名(カナ)",
            "example": "ギンザ",
            "minLength": 1,
            "maxLength": 15
        },
        "paymentApplicantNo": {
            "type": "string",
            "description": "振込依頼人番号",
            "example": "1234567890",
            "minLength": 1,
            "maxLength": 10
        },
        "ediInfo": {
            "type": "string",
            "description": "EDI情報",
            "example": "ＥＤＩ１２３４５６７８９０",
            "minLength": 1,
            "maxLength": 20
        },
        "debitCreditTypeCode": {
            "type": "string",
            "description": "入払区分コード",
            "example": "1：入金、2：出金",
            "minLength": 1,
            "maxLength": 1
        },
        "amount": {
            "type": "integer",
            "format": "int64",
            "description": "金額",
            "example": 600000,
            "minimum": 0,
            "maximum": 999999999999
        }
    },
    "additionalProperties": false
}

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

日本語名英字名説明Nullデータ
ステータスコードstatusステータスコード(※1)
メッセージmessageステータスコードに紐づくメッセージ(※1)
エラーコードcodeエラーコード(※1)
開発者向け詳細メッセージdeveloper_message開発者向けの詳細メッセージ(※1)
日本語名英字名説明Nullデータ
httpステータスコードhttpCodehttpステータスコードと同値(※1)
httpステータスメッセージhttpMessagehttpステータスコードの文字列(※1)
詳細メッセージmoreInformation開発者向けの詳細メッセージ(※1)
日本語名英字名説明Nullデータ
エラー種別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",
            "example": "不正なパラメータ"
        },
        "code": {
            "description": "エラーコード",
            "type": "string",
            "example": "ERR006"
        },
        "developer_message": {
            "description": "開発者向け詳細メッセージ",
            "type": "string",
            "example": "指定した口座からは振込できません。"
        },
        "httpCode": {
            "description": "httpステータスコード(httpステータスコードと同値)",
            "type": "string",
            "example": 404
        },
        "httpMessage": {
            "description": "httpステータスメッセージ(httpステータスコードの文字列)",
            "type": "string",
            "example": "Not Found"
        },
        "moreInformation": {
            "description": "詳細メッセージ(開発者向けの詳細メッセージ)",
            "type": "string",
            "example": "No resources match requested URI"
        },
        "error": {
            "description": "エラー種別(エラーの種別を表す文字列)",
            "type": "string",
            "example": "invalid_grant"
        },
        "error_description": {
            "description": "詳細メッセージ(開発者向けの詳細メッセージ)",
            "type": "string",
            "example": "client_id unauthorized"
        }
    }
}