ローン_v1

配信登録

Endpoints

production

development

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

Custom Gateway API Endpoint

パス

/

サマリー

ローン取引情報照会

説明

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

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

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

1) 照会可能な内容

　ダイレクトに登録されている指定した契約者のローン取引情報を照会します。
　体験コースで参照可能なデータについては、添付ファイル「テスト用ダミーデータ一覧」をご参照ください。

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

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

LoanResponse

default

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

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/retail/trial/v1/me/loans/

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/retail/trial/v1/me/loans/

ヘッダー

X-BTMU-Seq-No

要求

レスポンス

定義

LoanResponse

ローンレスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
件数	numberOfLoans	明細取得件数	なし	ZZ9形式
操作日	operationDate	システム日付（年月日）	なし	YYYY-MM-DD形式
操作時刻	operationTime	システム日付（時分秒）	なし	HH:MM:SS形式
エラーフラグ	errorFlag	エラーが発生し、ローン明細情報が欠落している状態を表す	(*1)	9形式エラーの場合は、"1"を設定正常終了の場合は、設定なし
ローン明細配列	loanDetails	ローン明細配列_LoanDetail	(*1)	以下の「ローン明細配列　LoanDetail」参照

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

{
    "type": "object",
    "properties": {
        "numberOfLoans": {
            "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
        },
        "errorFlag": {
            "description": "エラーが発生し、ローン明細情報が欠落している状態を表す",
            "type": "integer",
            "format": "int32",
            "example": 1,
            "minimum": 0,
            "maximum": 9
        },
        "loanDetails": {
            "description": "ローン明細配列_LoanDetail",
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/LoanDetail"
            },
            "example": ""
        }
    },
    "additionalProperties": false
}

LoanDetail

ローン明細配列

日本語名	英字名	説明	Nullデータ	備考
返済口座店番	repaymentBranchNo	返済口座店番	(*1)	999形式
返済口座店名	repaymentBranchName	返済用口座の店名	なし	全角
返済口座科目コード	repaymentAccountTypeCode	返済口座科目コード	(*1)	99形式 00:普通(貯蓄/マイカード/BCL) 01:当座(当座カードローン)
返済口座科目名	repaymentAccountTypeName	返済口座科目名	(*1)	全角
返済口座番号	repaymentAccountNo	返済口座番号	(*1)	9999999形式
返済口座名義	repaymentAccountName	サービス指定口座の口座名義	なし	全角／半角
取引番号	transactionNo	店番、取引先番号、取引番号を連結する項目	なし	999-9999999-9999999形式店番（3桁）＋"-"＋取引先番号（7桁）＋"-"＋取引番号（7桁）
当初借入日	initialBorrowingDate	当初お借り入日	(*1)	YYYY-MM-DD形式
当初借入金額	initialBorrowingAmount	当初お借入金額	なし	ZZZZZZZZZ9形式
当初借入金額（内毎月分）	initAmtForMonthlyRepayment	当初お借入金額（内毎月分）	なし	ZZZZZZZZZ9形式
当初借入金額（内ボーナス分）	initAmtForBonusRepayment	当初お借入金額（内ボーナス分）	なし	ZZZZZZZZZ9形式
当初借入金額（最終分）	initAmtForFinalRepayment	当初お借入金額（最終分）	なし	ZZZZZZZZZ9形式
利率（年利）	annualInterestRate	利率と上限利率	なし	全角／半角金利変動方式に"変動金利（上限付）"を含む場合、上限利率が表示される。
金利変動方式	interestRateType	金利変動方式	なし	全角／半角 ■返却値固定金利、固定金利（適用期間Z9年）、変動金利、変動金利（上限付）、変動金利（上限付）（適用期間Z9年）
適用期間満了日	expirationDate	適用期間満了日	(*1)	YYYY-MM-DD形式
返済方法	repaymentType	ご返済方法漢字名称	(*1)	全角 ■返却値期限一括、元金不均等、元金均等、元利逓増（毎）、元利逓増（毎ボ）、ステップ、ステップ（個社）、元利均等、元利不均等（補足　毎＝毎月返済、毎ボ＝毎月返済＋ボーナス返済）
現在残高	borrowingBalance	現在残高	なし	ZZZZZZZZZ9形式
現在残高（内毎月分）	balForMonthlyRepayment	現在残高（内毎月分）	なし	ZZZZZZZZZ9形式または "" 延滞中の場合は""
現在残高（内ボーナス分）	balForBonusRepayment	現在残高（内ボーナス分）	なし	ZZZZZZZZZ9形式または "" 延滞中の場合は""
現在残高（最終分）	balForFinalRepayment	現在残高（最終分）	なし	ZZZZZZZZZ9形式
毎月返済日	monthlyRepaymentDate	毎月ご返済日	(*1)	全角／半角
毎月返済金額	monthlyRepaymentAmount	毎月ご返済金額	なし	ZZZZZZZZZ9形式
ボーナス返済月	bonusRepaymentMonth	ボーナス返済対象の月	(*1)	全角／半角
ボーナス月返済金額	bonusRepaymentAmount	ボーナス月ご返済金額	なし	ZZZZZZZZZ9形式
次回返済日	nextRepaymentDate	次回ご返済日	(*1)	YYYY-MM-DD形式
次回返済金額	nextRepaymentAmount	次回支払予定額（毎月分）と次回支払予定額（ボーナス分）の合算	なし	ZZZZZZZZZZ9形式または "" 延滞中の場合は""
次回返済金額（内利息部分）	interestForNextRepaymentAmt	次回支払予定額（内利息）と次回支払予定額（内利息）（ボーナス分）の合算	なし	ZZZZZZZZZZ9形式または "" 延滞中の場合は""
最終返済日（毎月分）	finalMonthlyRepaymentDate	最終ご返済日（毎月分）	(*1)	YYYY-MM-DD形式
最終返済日（ボーナス分）	finalBonusRepaymentDate	最終ご返済日（ボーナス分）	(*1)	YYYY-MM-DD形式

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

{
    "type": "object",
    "properties": {
        "repaymentBranchNo": {
            "description": "返済口座店番",
            "type": "string",
            "example": "001",
            "minLength": 3,
            "maxLength": 3
        },
        "repaymentBranchName": {
            "description": "返済用口座の店名",
            "type": "string",
            "example": "本店",
            "minLength": 1,
            "maxLength": 20
        },
        "repaymentAccountTypeCode": {
            "description": "返済口座科目コード",
            "type": "string",
            "example": "00",
            "minLength": 2,
            "maxLength": 2
        },
        "repaymentAccountTypeName": {
            "description": "返済口座科目名",
            "type": "string",
            "example": "普通",
            "minLength": 2,
            "maxLength": 2
        },
        "repaymentAccountNo": {
            "description": "返済口座番号",
            "type": "string",
            "example": "1234567",
            "minLength": 7,
            "maxLength": 7
        },
        "repaymentAccountName": {
            "description": "サービス指定口座の口座名義",
            "type": "string",
            "example": "エジソン商事",
            "minLength": 1,
            "maxLength": 50
        },
        "transactionNo": {
            "description": "店番、取引先番号、取引番号を連結する項目",
            "type": "string",
            "example": "123-1234567-1234567",
            "minLength": 19,
            "maxLength": 19
        },
        "initialBorrowingDate": {
            "description": "当初お借り入日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "initialBorrowingAmount": {
            "description": "当初お借入金額",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "initAmtForMonthlyRepayment": {
            "description": "当初お借入金額（内毎月分）",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "initAmtForBonusRepayment": {
            "description": "当初お借入金額（内ボーナス分）",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "initAmtForFinalRepayment": {
            "description": "当初お借入金額（最終分）",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "annualInterestRate": {
            "description": "利率と上限利率",
            "type": "string",
            "example": "11.11111%（上限利率　22.22222%）",
            "minLength": 6,
            "maxLength": 25
        },
        "interestRateType": {
            "description": "金利変動方式",
            "type": "string",
            "example": "変動金利（上限付）（適用期間10年）",
            "minLength": 4,
            "maxLength": 18
        },
        "expirationDate": {
            "description": "適用期間満了日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "repaymentType": {
            "description": "ご返済方法漢字名称",
            "type": "string",
            "example": "元利均等",
            "minLength": 1,
            "maxLength": 11
        },
        "borrowingBalance": {
            "description": "現在残高",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "balForMonthlyRepayment": {
            "description": "現在残高（内毎月分）",
            "type": "string",
            "example": "8000000000",
            "minLength": 1,
            "maxLength": 10
        },
        "balForBonusRepayment": {
            "description": "現在残高（内ボーナス分）",
            "type": "string",
            "example": "8000000000",
            "minLength": 1,
            "maxLength": 10
        },
        "balForFinalRepayment": {
            "description": "現在残高（最終分）",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "monthlyRepaymentDate": {
            "description": "毎月ご返済日",
            "type": "string",
            "example": "10日",
            "minLength": 2,
            "maxLength": 3
        },
        "monthlyRepaymentAmount": {
            "description": "毎月ご返済金額",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "bonusRepaymentMonth": {
            "description": "ボーナス返済対象の月",
            "type": "string",
            "example": "11月、12月",
            "minLength": 2,
            "maxLength": 7
        },
        "bonusRepaymentAmount": {
            "description": "ボーナス月ご返済金額",
            "type": "integer",
            "format": "int64",
            "example": 8000000000,
            "minimum": 0,
            "maximum": 9999999999
        },
        "nextRepaymentDate": {
            "description": "次回ご返済日",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "nextRepaymentAmount": {
            "description": "次回支払予定額（毎月分）と次回支払予定額（ボーナス分）の合算",
            "type": "string",
            "example": "80000000000",
            "minLength": 1,
            "maxLength": 11
        },
        "interestForNextRepaymentAmt": {
            "description": "次回支払予定額（内利息）と次回支払予定額（内利息）（ボーナス分）の合算",
            "type": "string",
            "example": "80000000000",
            "minLength": 1,
            "maxLength": 11
        },
        "finalMonthlyRepaymentDate": {
            "description": "最終ご返済日（毎月分）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        },
        "finalBonusRepaymentDate": {
            "description": "最終ご返済日（ボーナス分）",
            "type": "string",
            "example": "2016-07-15",
            "minLength": 10,
            "maxLength": 10
        }
    },
    "additionalProperties": false
}

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

メニュー

ローン_v1

ローン_v1

パス

/

1) 照会可能な内容

2) 返却内容説明

定義