給与賞与振込

配信登録

Endpoints

production

development

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

Custom Gateway API Endpoint

パス

/

サマリー

給与賞与振込申請

説明

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

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

概要
　BizSTATIONに登録したサービス指定口座から、任意の口座への給与賞与振込を申請します。（1申請で最大2,000明細）

1) 引落口座として指定可能な口座

　添付ファイル「テスト用ダミーデータ一覧」記載の口座のみ、引落口座として指定できます。
　以外の口座を指定した場合は、エラーとなります。
　また、1度の申請で指定できるのは1口座のみで、複数の引落口座は指定できません。

2) 利用可能な科目

　普通預金、当座預金です。

3) 振込の単位

　最大2,000明細の給与賞与振込申請が可能です。

4) エラー時の応答について

　申請したデータに１明細でも異常がある場合は、申請できません。
　申請したデータに異常があった場合、異常のあったデータに応じて以下のエラー応答を返却します。
　エラー応答の詳細は、添付ファイル「【総給振】エラー応答」および、下記「定義」をご参照ください。

　【異常明細があり、申請が完了しなかった場合】
　申請したデータにI/Fフォーマットエラー（属性異常、桁数異常）以外の異常がある場合、応答としてエラーの詳細情報を含んだ「Payroll400ErrorResponse」の応答を返却します。

　【その他の場合】
　申請したデータにI/Fフォーマットエラー（属性異常、桁数異常）があった場合は応答として「ErrorResponse」の応答を返却します。

セキュリティー

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
}

Content-Type

header で必須

string

コンテントタイプ
フォームの送信の際のコンテントタイプ
Nullデータ指定不可
"application/json"（固定）

header でオプション

string

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

CreatePayroll

body で必須

object

給与賞与振込申請リクエストオブジェクト
給与賞与振込申請の情報
Nullデータ指定不可

CreatePayroll

応答

201

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

PayrollResponse

400

異常終了（エラー明細あり）
給与賞与振込申請エラーレスポンスオブジェクト
Nullデータの返却なし

Payroll400ErrorResponse

default

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

ErrorResponse

要求の例

応答の例

定義

POST https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/

本文

ヘッダー

content-type

X-BTMU-Seq-No

要求

レスポンス

/{acceptance_no}

サマリー

給与賞与振込受付明細照会

説明

概要
　APIより申請されたデータの最新の受付状態や明細を返却します。
　照会はAPIからの申請時に返却される受付番号をキーに行います。

1) 照会可能な受付明細

　添付ファイル「テスト用ダミーデータ一覧」記載の受付明細のみ指定できます。
　以外の受付明細を照会した場合は、エラーとなります。

ステータス	概要
申請済	APIより申請され、Web画面上での承認が未済の状態
申請済（差戻）	Web画面上で承認権限者に差し戻された状態
申請済（予約取消）	Web画面上で承認された後に、取り消された状態
一時保存	APIより申請され後にデータが更新され、申請がキャンセルされた状態（データの更新が発生するのは、お客さまのWeb画面操作で手数料の適用額等が変更された場合や、明示的に一時保存に戻された場合）
一次承認済	Web画面上で一次承認権限者が承認した状態（別の一次承認権限者あるいは承認権限者による承認が必要）
承認済	Web画面上での承認が完了した状態（Web画面上での予約取消は可能）
受付済	Web画面上での承認後、当行の勘定系システムの処理に引き渡した状態（Web画面上での予約取消は不可）

2) 照会の単位

　最大2,000明細の受付明細照会が可能です。
　（APIで申請可能な最大明細数）

セキュリティー

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

acceptance_no

path で必須

string

受付番号
申請時に返却される受付番号
Nullデータ指定不可
給与賞与振込申請で返却された受付番号

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

応答

200

正常終了
レスポンス内容は、給与賞与振込受付明細照会レスポンスオブジェクトをご参照ください。
給与賞与振込受付明細照会レスポンスオブジェクト
Nullデータの返却なし

PayrollDetailsInquiryResponse

default

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

ErrorResponse

要求の例

応答の例

定義

GET https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/{acceptance_no}

レスポンス

この操作を試してみる

https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/{acceptance_no}

ヘッダー

X-BTMU-Seq-No

パラメーター

acceptance_no

要求

レスポンス

定義

CreatePayroll

給与賞与振込申請リクエストオブジェクト

日本語名	英字名	説明	Nullデータ	備考
振込データ名	paymentDataName	振込データの名称	(※1)	全角文字すべて
コード優先フラグ	codeOnlyFlag	振込先金融機関名(カナ)、振込先支店名(カナ)を無効とし、コード（振込先金融機関番号・振込先支店番号）のみで振込先金融機関を指定する	不可	0：コード優先無し、1：コード優先有り
種別変更許容フラグ	typeChangeFlag	受付時限超過時に総合振込み扱いを許容するか否かを指定する	不可	0：許容、1：非許容
給与賞与振込申請ロット情報	payrollInfo	給与賞与振込申請ロット情報オブジェクト参照	不可

(※1) 値を設定しない場合は、キー・値自体を設定しないでください。
"Key"：Null　の指定はできません。

{
    "properties": {
        "paymentDataName": {
            "type": "string",
            "description": "振込データ名",
            "minLength": 1,
            "maxLength": 60,
            "example": "０１０１　月末支払１"
        },
        "codeOnlyFlag": {
            "type": "string",
            "description": "コード優先フラグ",
            "minLength": 1,
            "maxLength": 1,
            "example": "0"
        },
        "typeChangeFlag": {
            "type": "string",
            "description": "種別変更許容フラグ",
            "minLength": 1,
            "maxLength": 1,
            "example": "1"
        },
        "payrollInfo": {
            "description": "給与賞与振込申請ロット情報オブジェクト",
            "$ref": "#\/definitions\/PayrollRequestInfo"
        }
    },
    "additionalProperties": false,
    "required": [
        "codeOnlyFlag",
        "typeChangeFlag",
        "payrollInfo"
    ]
}

PayrollRequestInfo

給与賞与振込申請ロット情報オブジェクト

日本語名	英字名	説明	Nullデータ	備考
種別コード	transactionCode	種別コード	不可	11：給与振込（民間） 12：賞与振込（民間） 51：給与振込（国庫金） 52：賞与振込（国庫金） 71：給与振込（公金） 72：賞与振込（公金）
会社コード	companyCode	振込依頼人コード（取引企業コード）	(※1)	半角数字 "^(\d{1,10})$"
会社名(カナ)	companyName	振込の依頼人名	不可	全角数字、全角英字、全角カナ、許容記号1(※2)
振込指定日	paymentDate	振込の指定日	不可	YYYY-MM-DD形式
引落口座金融機関番号	payingBankNo	引落口座の銀行番号	不可	半角数字"0005"のみ許容
引落口座金融機関名(カナ)	payingBankName	引落口座の銀行名	(※1)	※全銀フォーマット準拠の為の項目当APIでは未使用の為、読み捨て
引落口座支店番号	payingBranchNo	引落口座の支店番号	不可	半角数字 "^(\d{3})$"
引落口座支店名(カナ)	payingBranchName	引落口座の支店名	(※1)	※全銀フォーマット準拠の為の項目当APIでは未使用の為、読み捨て
引落口座預金種目	payingDepositType	引落口座の科目コード	不可	1：普通預金　2：当座預金
引落口座口座番号	payingAccountNo	引落口座の口座番号	不可	半角数字 "^(\d{7})$"
給与賞与振込申請明細配列	payrollRequestDetails	振込先の明細情報	不可
合計件数	totalNumber	振込先の合計件数	不可	0～999999
合計金額	totalAmount	振込先の合計金額	不可	0～999999999999

(※1) 値を設定しない場合は、キー・値自体を設定しないでください。

　　　"Key":Null　の指定はできません。

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

　　の計21文字になります。

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

{
    "properties": {
        "transactionCode": {
            "type": "string",
            "description": "種別コード",
            "minLength": 2,
            "maxLength": 2,
            "example": "11"
        },
        "companyCode": {
            "type": "string",
            "description": "会社コード",
            "minLength": 1,
            "maxLength": 10,
            "example": "1234567890"
        },
        "companyName": {
            "type": "string",
            "description": "会社名(カナ)",
            "minLength": 1,
            "maxLength": 40,
            "example": "カ）ヤマダショウテン"
        },
        "paymentDate": {
            "type": "string",
            "description": "振込指定日",
            "minLength": 10,
            "maxLength": 10,
            "example": "2016-07-15"
        },
        "payingBankNo": {
            "type": "string",
            "description": "引落口座 金融機関番号",
            "minLength": 4,
            "maxLength": 4,
            "example": "0005"
        },
        "payingBankName": {
            "type": "string",
            "description": "引落口座 金融機関名(カナ)",
            "minLength": 1,
            "maxLength": 15,
            "example": "ミツビシユーエフジエイ"
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "minLength": 3,
            "maxLength": 3,
            "example": "001"
        },
        "payingBranchName": {
            "type": "string",
            "description": "引落口座 支店名(カナ)",
            "minLength": 1,
            "maxLength": 15,
            "example": "ホンテン"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "minLength": 1,
            "maxLength": 1,
            "example": "2"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "minLength": 7,
            "maxLength": 7,
            "example": "1234567"
        },
        "payrollRequestDetails": {
            "type": "array",
            "description": "給与賞与振込申請明細配列",
            "items": {
                "$ref": "#\/definitions\/PayrollRequestDetailInfo"
            }
        },
        "totalNumber": {
            "type": "integer",
            "description": "合計件数",
            "format": "int32",
            "minimum": 0,
            "maximum": 999999,
            "example": 1
        },
        "totalAmount": {
            "type": "integer",
            "description": "合計金額",
            "format": "int64",
            "minimum": 0,
            "maximum": 999999999999,
            "example": 8000000
        }
    },
    "additionalProperties": false,
    "required": [
        "transactionCode",
        "companyName",
        "paymentDate",
        "payingBankNo",
        "payingBranchNo",
        "payingDepositType",
        "payingAccountNo",
        "payrollRequestDetails",
        "totalNumber",
        "totalAmount"
    ]
}

PayrollRequestDetailInfo

給与賞与振込申請明細オブジェクト

日本語名	英字名	説明	Nullデータ	備考
振込先金融機関番号	receivingBankNo	振込先の金融機関番号	不可	全銀フォーマット許容文字（※2）
振込先金融機関名(カナ)	receivingBankName	振込先の金融機関名	（※1）	全銀フォーマット許容文字（※2）
振込先支店番号	receivingBranchNo	振込先の支店番号	不可	全銀フォーマット許容文字（※2）
振込先支店名(カナ)	receivingBranchName	振込先の支店名	（※1）	全銀フォーマット許容文字（※2）
手形交換所番号	clearingHouseNo	手形交換所の番号	（※1）	※全銀フォーマット準拠の為の項目当APIでは未使用の為、読み捨て
振込先預金種目	receivingDepositType	振込先の科目コード	不可	1：普通預金　2：当座預金
振込先口座番号	receivingAccountNo	振込先の口座番号	不可	全銀フォーマット許容文字（※2）
振込先預金者名（カナ）	receivingBeneficiaryName	振込先の口座名義	不可	全銀フォーマット許容文字（※2）
入力金額	paymentAmount	振込金額	不可	0～9999999999
新規コード	newAmendCode	新規コード	（※1）	※全銀フォーマット準拠の為の項目当APIでは未使用の為、読み捨て
社員番号	companyEmployeeNumber	社員番号	（※1）	全銀フォーマット許容文字（※2）
所属コード	divisionDepartmentCode	所属コード	（※1）	全銀フォーマット許容文字（※2）

(※1) 値を設定しない場合は、キー・値自体を設定しないでください。

　　　"Key":Null　の指定はできません。

(※2) 半角/全角英数、半角/全角カナ記号、全銀フォーマット許容記号

　　　（半角/全角文字で、濁点・半濁点、特殊文字（(ｽﾍﾟｰｽ)｡｢｣､･[].<>{}()!&ｰ-*;/,:'+|%_?#@="$））

{
    "properties": {
        "receivingBankNo": {
            "type": "string",
            "description": "振込先 金融機関番号",
            "minLength": 4,
            "maxLength": 4,
            "example": "0005"
        },
        "receivingBankName": {
            "type": "string",
            "description": "振込先 金融機関名(カナ)",
            "minLength": 1,
            "maxLength": 15,
            "example": "ミツビシＵＦＪ"
        },
        "receivingBranchNo": {
            "type": "string",
            "description": "振込先 支店番号",
            "minLength": 3,
            "maxLength": 3,
            "example": "123"
        },
        "receivingBranchName": {
            "type": "string",
            "description": "振込先 支店名(カナ)",
            "minLength": 1,
            "maxLength": 15,
            "example": "ギンザ"
        },
        "clearingHouseNo": {
            "type": "string",
            "description": "手形交換所番号",
            "minLength": 1,
            "maxLength": 4,
            "example": "0001"
        },
        "receivingDepositType": {
            "type": "string",
            "description": "振込先 預金種目",
            "minLength": 1,
            "maxLength": 1,
            "example": "1"
        },
        "receivingAccountNo": {
            "type": "string",
            "description": "振込先 口座番号",
            "minLength": 1,
            "maxLength": 7,
            "example": "1234567"
        },
        "receivingBeneficiaryName": {
            "type": "string",
            "description": "振込先 預金者名（カナ）",
            "minLength": 1,
            "maxLength": 30,
            "example": "ｷﾞﾝｻﾞﾘﾖｳｼｬ07"
        },
        "paymentAmount": {
            "type": "integer",
            "description": "入力金額",
            "format": "int64",
            "minimum": 0,
            "maximum": 9999999999,
            "example": 8000000
        },
        "newAmendCode": {
            "type": "string",
            "description": "新規コード",
            "minLength": 1,
            "maxLength": 1,
            "example": "0"
        },
        "companyEmployeeNumber": {
            "type": "string",
            "description": "社員番号",
            "minLength": 1,
            "maxLength": 10,
            "example": "1234567890"
        },
        "divisionDepartmentCode": {
            "type": "string",
            "description": "所属コード",
            "minLength": 1,
            "maxLength": 10,
            "example": "8"
        }
    },
    "additionalProperties": false,
    "required": [
        "receivingBankNo",
        "receivingBranchNo",
        "receivingDepositType",
        "receivingAccountNo",
        "receivingBeneficiaryName",
        "paymentAmount"
    ]
}

PayrollResponse

給与賞与振込申請レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
申請日	appliedDate	申請した日付	なし	YYYY-MM-DD形式
申請時刻	appliedTime	申請した時刻	なし	HH：MM：SS形式
申請ステータス	appliedStatus	申請した結果	なし	booking：申請中、failed：申請失敗
エラーコード	errorCode	エラーコード	(※1)	申請ステータスがfailedの場合のみ、エラーコードをセット
エラー文言	errorInfo	エラー文言	(※1)	申請ステータスがfailedの場合のみ、エラー文言をセット
申請結果	payrollResult	申請結果詳細オブジェクト　参照	なし

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

{
    "properties": {
        "appliedDate": {
            "type": "string",
            "description": "申請日",
            "example": "2017-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "13:23:04"
        },
        "appliedStatus": {
            "type": "string",
            "description": "申請ステータス",
            "example": "booking"
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APISFD5014"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "振込明細にエラー分があるため申請できません"
        },
        "payrollResult": {
            "description": "申請結果",
            "$ref": "#\/definitions\/PayrollResultInfo",
            "example": ""
        }
    },
    "additionalProperties": false
}

PayrollResultInfo

申請結果詳細オブジェクト

日本語名	英字名	説明	Nullデータ	備考
受付番号	acceptanceNo	給与賞与振込受付番号	(※1)	申請ステータスがfailedの場合は、Null 半角数字 "^(\d{12})$"
種別	type	種別	なし（※2）	給与振込（民間）、賞与振込（民間）、給与振込（国庫金）、賞与振込（国庫金）、給与振込（公金）、賞与振込（公金）
種別変更フラグ	typeChangeFlag	種別変更の有無表示	なし（※2）	種別変更なし、種別変更あり
会社名（カナ）	companyName	振込会社名	なし（※2）
会社コード	companyCode	会社コード	(※1)
振込指定日	paymentDate	振込の指定日	なし（※2）	YYYY-MM-DD形式
振込データ名	paymentDataName	振込データの名称	なし（※2）
明細件数	numberOfDetails	振込先の合計件数	なし（※2）
入力金額合計	totalEnteredAmount	振込先の合計金額	なし（※2）
振込金額合計	totalPaymentAmount	振込先の振込金額合計	（※1）	申請ステータスがfailedの場合は、Null
引落口座金融機関番号	payingBankNo	引落口座の銀行番号	なし（※2）
引落口座金融機関名	payingBankNameKanji	引落口座の銀行名	なし
引落口座支店番号	payingBranchNo	引落口座の支店番号	なし（※2）
引落口座支店名	payingBranchNameKanji	引落口座の支店名	（※1）	申請ステータスがfailedの場合は、Null
引落口座預金種目	payingDepositType	引落口座の科目コード	なし（※2）
引落口座預金種目名	payingDepositTypeName	引落口座の科目名称	（※1）
引落口座口座番号	payingAccountNo	引落口座の口座番号	なし（※2）
引落口座口座名義(漢字)	payingAccountNameKanji	引落口座の名義（漢字）・取引先名（漢字）＋付属取引先名（漢字）・取引先名（漢字）がないとき、　取引先名（カナ）＋付属取引先名（カナ）	（※1）
引落口座口座名義(カナ)	payingAccountName	引落口座の名義（カナ）取引先名（カナ）＋付属取引先名（カナ）	（※1）
エラー明細件数	numberOfError	エラー明細の件数	なし
エラー情報配列	payrollError	エラー明細の内容（リクエスト）	（※1）

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

(※2) リクエストの値を返却するケースで、リクエストの値が設定されていない場合はNullとなる。

{
    "properties": {
        "acceptanceNo": {
            "type": "string",
            "description": "受付番号",
            "example": "201702134567"
        },
        "type": {
            "type": "string",
            "description": "種別",
            "example": "給与振込"
        },
        "typeChangeFlag": {
            "type": "string",
            "description": "種別変更許容フラグ",
            "example": "種別変更なし"
        },
        "companyName": {
            "type": "string",
            "description": "会社名(カナ)",
            "example": "カ）ヤマダショウテン"
        },
        "companyCode": {
            "type": "string",
            "description": "会社コード",
            "example": "1234567890"
        },
        "paymentDate": {
            "type": "string",
            "description": "振込指定日",
            "example": "2016-07-15"
        },
        "paymentDataName": {
            "type": "string",
            "description": "振込データ名",
            "example": "０１０１　月末支払１"
        },
        "numberOfDetails": {
            "type": "integer",
            "description": "明細件数",
            "format": "int32",
            "example": "100"
        },
        "totalEnteredAmount": {
            "type": "integer",
            "description": "入力金額合計",
            "format": "int64",
            "example": "2000000"
        },
        "totalPaymentAmount": {
            "type": "integer",
            "description": "振込金額合計",
            "format": "int64",
            "example": "2000000"
        },
        "payingBankNo": {
            "type": "string",
            "description": "引落口座 金融機関番号",
            "example": "0005"
        },
        "payingBankNameKanji": {
            "type": "string",
            "description": "引落口座 金融機関名",
            "example": "三菱ＵＦＪ銀行"
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "example": "001"
        },
        "payingBranchNameKanji": {
            "type": "string",
            "description": "引落口座 支店名",
            "example": "本店"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "example": "2"
        },
        "payingDepositTypeName": {
            "type": "string",
            "description": "引落口座 預金種目名",
            "example": "当座"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "example": "1234567"
        },
        "payingAccountNameKanji": {
            "type": "string",
            "description": "引落口座 口座名義(漢字)",
            "example": "銀座利用者０７"
        },
        "payingAccountName": {
            "type": "string",
            "description": "引落口座 口座名義(カナ)",
            "example": "ギンザリヨウシャ０７"
        },
        "numberOfError": {
            "type": "integer",
            "description": "エラー明細件数",
            "format": "int32",
            "example": "100"
        },
        "payrollError": {
            "type": "array",
            "description": "エラー情報配列",
            "items": {
                "$ref": "#\/definitions\/PayrollErrorInfo"
            }
        }
    },
    "additionalProperties": false
}

PayrollErrorInfo

エラー情報詳細オブジェクト

日本語名	英字名	説明	Nullデータ
明細通番	recordNo	リクエスト明細の順番	なし
エラーコード	errorCode	エラーコード	なし
エラー文言	errorInfo	エラー文言	なし
エラーデータ	errorData	エラーとなったリクエストデータ	（※1）

（※1）給与賞与振込サービスの権限が「申請権限（ファイル取込のみ）」の利用者の場合はキー・値ともに返却しません。

{
    "properties": {
        "recordNo": {
            "type": "integer",
            "description": "明細通番",
            "format": "int32",
            "example": 1
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APISFD6001"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "振込先 金融機関番号が正しくありません"
        },
        "errorData": {
            "description": "エラーデータ",
            "example": "",
            "$ref": "#\/definitions\/PayrollRequestDetailInfo"
        }
    },
    "additionalProperties": false
}

PayrollDetailsInquiryResponse

給与賞与振込受付明細照会レスポンスオブジェクト

日本語名	英字名	説明	Nullデータ	備考
取引ステータス	transactionStatus	受付明細の状態	なし	"一時保存"、"申請済"、"申請済（差戻）"、"申請済（予約取消）"、"一次承認済"、"承認済"、"受付済"
取引ステータスコード	transactionStatusCode	取引ステータスコード	なし	1:一時保存、2：申請済、3：一次承認済、 4：承認済、5：処理済
申請済区分	appliedStatusCode	申請済区分	(※1)	1：通常、2：差戻、3：予約取消
操作日	operationDate	当APIを実行した日付	なし	YYYY-MM-DD形式
操作時刻	operationTime	当APIを実行した時刻	なし	HH：MM：SS形式
取引日付	transactionDate	直近の操作の日付　詳細は(※2)	なし	YYYY-MM-DD形式
取引時刻	transactionTime	直近の操作の時刻　詳細は(※2)	なし	HH：MM：SS形式
申請日付	appliedDate	API取引から申請した日付　詳細は(※2) （あるいはWeb上で再申請した場合は、その日付）	(※1)	YYYY-MM-DD形式
申請時刻	appliedTime	API取引から申請した時刻　詳細は(※2) （あるいはWeb上で再申請した場合は、その時刻）	(※1)	HH：MM：SS形式
一次承認日付	firstApprovedDate	Web上で一次承認した日付　詳細は(※2)	(※1)	YYYY-MM-DD形式
一次承認時刻	firstApprovedTime	Web上で一次承認した時刻　詳細は(※2)	(※1)	HH：MM：SS形式
承認日付	approvedDate	Web上で承認した日付　詳細は(※2)	(※1)	YYYY-MM-DD形式
承認時刻	approvedTime	Web上で承認した時刻　詳細は(※2)	(※1)	HH：MM：SS形式
受付番号	acceptanceNo	給与賞与振込申請時の受付番号	なし	半角数字 "^(\d{12})$"
種別	type	種別	なし	"給与振込（民間）"、"賞与振込（民間）"、"給与振込（国庫金）"、"賞与振込（国庫金）"、"給与振込（公金）"、"賞与振込（公金）"
種別変更フラグ	typeChangeFlag	種別変更フラグ	なし	"種別変更なし"、"種別変更あり"
会社名（カナ）	companyName	振込依頼人名(カナ)	(※1)	全角数字、全角英字、全角カナ、許容記号1(※3)
会社コード	companyCode	振込依頼人コード	(※1)	半角数字 "^(\d{10})$"
振込指定日	paymentDate	振込指定日	(※1)	YYYY-MM-DD形式
振込データ名	paymentDataName	振込データ名	(※1)	全角文字すべて
引落口座金融機関番号	payingBankNo	引落口座金融機関番号	なし	固定値："0005"
引落口座金融機関名	payingBankNameKanji	引落口座金融機関名	なし	固定値："三菱ＵＦＪ銀行"
引落口座支店番号	payingBranchNo	引落口座支店番号	なし	半角数字 "^(\d{3})$"
引落口座支店名	payingBranchNameKanji	引落口座支店名	なし	全角文字すべて
引落口座預金種目	payingDepositType	引落口座預金種目	なし	1：普通預金　2：当座預金
引落口座預金種目名	payingDepositTypeName	引落口座預金種目名	なし	全角文字すべて
引落口座口座番号	payingAccountNo	引落口座口座番号	なし	半角数字 "^(\d{7})$"
引落口座口座名義(漢字)	payingAccountNameKanji	引落口座口座名義(漢字)	なし	全角文字すべて
引落口座口座名義(カナ)	payingAccountName	引落口座口座名義(カナ)	なし	全角数字、全角英字、全角カナ、許容記号1(※3)
明細件数	numberOfDetails	全明細の件数	なし	0～2000
入力金額合計	totalEnteredAmount	申請時に入力された金額	なし	0～999999999999
正常明細件数	numberOfValidDetails	正常な明細件数	なし	0～2000
正常入力金額合計	totalAmountOfValidEntry	正常な明細の合計金額	なし	0～999999999999
エラー明細件数	numberOfErrorDetails	エラーとなった明細件数	なし	0～2000
エラー入力金額合計	totalAmountOfDetailsWithErrors	エラーとなった明細の合計金額	なし	0～999999999999
振込金額合計	totalPaymentAmount	振込金額合計	なし	0～999999999999
明細配列	normalDetails	明細情報の詳細	なし

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

(※2) 取引ステータスによって設定される値が異なり、取引操作によって変わる最新の日時が設定される。

取引ステータス	項目
取引ステータス	取引日付/時刻に設定される内容	申請日付/時刻設定有無	一次承認日付/時刻設定有無	承認日付／時刻設定有無
申請済	APIで申請した日時 Web上で再申請した場合は、その日時	あり	なし	なし
申請済（差戻）	Web上で差戻した日時	あり	なし	なし
申請済（予約取消）	Web上で取り消した日時	あり	なし	なし
一時保存	Web上で一時保存に戻した日時	なし	なし	なし
一次承認済	Web上で一次承認した日時	あり	あり	なし
承認済	Web上で承認した日時	あり	一次承認から承認した場合のみ、あり	あり
受付済	Web上で承認した日時	あり	一次承認から承認した場合のみ、あり	あり

(※3) ￥「」（）／＊＆＄，．＠＝％＋；スペースー(カナ長音)－(ハイフン)―(２バイトの長い横棒)‐(２バイトの短い横棒)

　　の計21文字になります。

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

{
    "properties": {
        "transactionStatus": {
            "type": "string",
            "description": "取引ステータス",
            "example": "承認済"
        },
        "transactionStatusCode": {
            "type": "string",
            "description": "取引ステータスコード",
            "example": "1"
        },
        "appliedStatusCode": {
            "type": "string",
            "description": "申請済区分",
            "example": "1"
        },
        "operationDate": {
            "type": "string",
            "description": "操作日",
            "example": "2016-07-15"
        },
        "operationTime": {
            "type": "string",
            "description": "操作時刻",
            "example": "01:23:04"
        },
        "transactionDate": {
            "type": "string",
            "description": "取引日付",
            "example": "2016-07-15"
        },
        "transactionTime": {
            "type": "string",
            "description": "取引時刻",
            "example": "01:23:04"
        },
        "appliedDate": {
            "type": "string",
            "description": "申請日付",
            "example": "2016-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "01:23:04"
        },
        "firstApprovedDate": {
            "type": "string",
            "description": "一次承認日付",
            "example": "2016-07-15"
        },
        "firstApprovedTime": {
            "type": "string",
            "description": "一次承認時刻",
            "example": "01:23:04"
        },
        "approvedDate": {
            "type": "string",
            "description": "承認日付",
            "example": "2016-07-15"
        },
        "approvedTime": {
            "type": "string",
            "description": "承認時刻",
            "example": "01:23:04"
        },
        "acceptanceNo": {
            "type": "string",
            "description": "受付番号",
            "example": "201702134567"
        },
        "type": {
            "type": "string",
            "description": "種別",
            "example": "給与振込（民間）"
        },
        "typeChangeFlag": {
            "type": "string",
            "description": "種別変更許容フラグ",
            "example": "種別変更なし"
        },
        "companyName": {
            "type": "string",
            "description": "会社名（カナ）",
            "example": "エジソンショウジ"
        },
        "companyCode": {
            "type": "string",
            "description": "会社コード",
            "example": "1234567890"
        },
        "paymentDate": {
            "type": "string",
            "description": "振込指定日",
            "example": "2016-07-15"
        },
        "paymentDataName": {
            "type": "string",
            "description": "振込データ名",
            "example": "０１０１　月末支払１"
        },
        "payingBankNo": {
            "type": "string",
            "description": "引落口座 金融機関番号",
            "example": "0005"
        },
        "payingBankNameKanji": {
            "type": "string",
            "description": "引落口座 金融機関名",
            "example": "三菱ＵＦＪ銀行"
        },
        "payingBranchNo": {
            "type": "string",
            "description": "引落口座 支店番号",
            "example": "001"
        },
        "payingBranchNameKanji": {
            "type": "string",
            "description": "引落口座 支店名",
            "example": "本店"
        },
        "payingDepositType": {
            "type": "string",
            "description": "引落口座 預金種目",
            "example": "1"
        },
        "payingDepositTypeName": {
            "type": "string",
            "description": "引落口座 預金種目名",
            "example": "普通"
        },
        "payingAccountNo": {
            "type": "string",
            "description": "引落口座 口座番号",
            "example": "1234567"
        },
        "payingAccountNameKanji": {
            "type": "string",
            "description": "引落口座 口座名義(漢字)",
            "example": "銀座利用者０７"
        },
        "payingAccountName": {
            "type": "string",
            "description": "引落口座 口座名義(カナ)",
            "example": "ギンザリヨウシャ０７"
        },
        "numberOfDetails": {
            "type": "integer",
            "description": "明細件数",
            "format": "int32",
            "example": 100
        },
        "totalEnteredAmount": {
            "type": "integer",
            "description": "入力金額合計",
            "format": "int64",
            "example": 2000000
        },
        "numberOfValidDetails": {
            "type": "integer",
            "description": "正常明細件数",
            "format": "int32",
            "example": 100
        },
        "totalAmountOfValidEntry": {
            "type": "integer",
            "description": "正常入力金額合計",
            "format": "int64",
            "example": 2000000
        },
        "numberOfErrorDetails": {
            "type": "integer",
            "description": "エラー明細件数",
            "format": "int32",
            "example": 100
        },
        "totalAmountOfDetailsWithErrors": {
            "type": "integer",
            "description": "エラー入力金額合計",
            "format": "int64",
            "example": 2000000
        },
        "totalPaymentAmount": {
            "type": "integer",
            "description": "振込金額合計",
            "format": "int64",
            "example": 2000000
        },
        "normalDetails": {
            "type": "array",
            "description": "明細配列",
            "items": {
                "$ref": "#\/definitions\/PayrollDetailInfo"
            }
        }
    },
    "additionalProperties": false
}

PayrollDetailInfo

明細情報オブジェクト

日本語名	英字名	説明	Nullデータ	備考
明細通番	recordNo	明細通番	なし	1～2000
社員番号	companyEmployeeNumber	社員番号	(※1)	全角数字、全角英字、全角カナ、許容記号2(※3)
所属コード	divisionDepartmentCode	所属コード	(※1)	全角数字、全角英字、全角カナ、許容記号2(※3)
振込先金融機関番号	receivingBankNo	振込先金融機関番号	(※1)	半角数字 "^(\d{4})$"
振込先金融機関名	receivingBankNameKanji	振込先金融機関名	(※1)	全角文字すべて
振込先金融機関名(カナ)	receivingBankName	振込先金融機関名(カナ)	(※1)	全角数字、全角英字、全角カナ、許容記号1(※2)
振込先支店番号	receivingBranchNo	振込先支店番号	(※1)	半角数字 "^(\d{3})$"
振込先支店名	receivingBranchNameKanji	振込先支店名	(※1)	全角文字すべて
振込先支店名(カナ)	receivingBranchName	振込先支店名(カナ)	(※1)	全角数字、全角英字、全角カナ、許容記号1(※2)
振込先預金種目	receivingDepositType	振込先預金種目	なし	1：普通預金　2：当座預金 4：貯蓄預金　9：その他
振込先預金種目名	receivingDepositTypeName	振込先預金種目名	なし	全角文字すべて
振込先口座番号	receivingAccountNo	振込先口座番号	(※1)	半角数字 "^(\d{7})$"
預金者名（カナ）	receivingBeneficiaryName	振込先口座名義(カナ)	なし	全角数字、全角英字、全角カナ、許容記号1(※2)
入力金額	enteredAmount	申請時に入力された金額	(※1)	0～9999999999
振込金額	paymentAmount	振込金額合計	なし	0～9999999999
エラーコード	errorCode	異常のあった明細のエラーコード	(※1)
エラー文言	errorInfo	異常のあった明細のエラーメッセージ	(※1)	全角文字すべて

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

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

　　の計21文字になります。

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

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

{
    "properties": {
        "recordNo": {
            "type": "integer",
            "description": "明細通番",
            "format": "int32",
            "example": 1
        },
        "companyEmployeeNumber": {
            "type": "string",
            "description": "社員番号",
            "example": "ａｂｃ０１２３４５０"
        },
        "divisionDepartmentCode": {
            "type": "string",
            "description": "所属コード",
            "example": "ａｂｃ０１２３４５０"
        },
        "receivingBankNo": {
            "type": "string",
            "description": "振込先 金融機関番号",
            "example": "0005"
        },
        "receivingBankNameKanji": {
            "type": "string",
            "description": "振込先 金融機関名",
            "example": "三菱ＵＦＪ銀行"
        },
        "receivingBankName": {
            "type": "string",
            "description": "振込先 金融機関名(カナ)",
            "example": "ミツビシＵＦＪ"
        },
        "receivingBranchNo": {
            "type": "string",
            "description": "振込先 支店番号",
            "example": "123"
        },
        "receivingBranchNameKanji": {
            "type": "string",
            "description": "振込先 支店名",
            "example": "銀座"
        },
        "receivingBranchName": {
            "type": "string",
            "description": "振込先 支店名(カナ)",
            "example": "ギンザ"
        },
        "receivingDepositType": {
            "type": "string",
            "description": "振込先 預金種目",
            "example": "1"
        },
        "receivingDepositTypeName": {
            "type": "string",
            "description": "振込先 預金種目名",
            "example": "普通"
        },
        "receivingAccountNo": {
            "type": "string",
            "description": "振込先 口座番号",
            "example": "1234567"
        },
        "receivingBeneficiaryName": {
            "type": "string",
            "description": "振込先 預金者名（カナ）",
            "example": "ギンザリヨウシャ０７"
        },
        "enteredAmount": {
            "type": "integer",
            "description": "入力金額",
            "format": "int64",
            "example": 8000000
        },
        "paymentAmount": {
            "type": "integer",
            "description": "振込金額",
            "format": "int64",
            "example": 8000000
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APIKFU6002"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "該当する支店がありません"
        }
    },
    "additionalProperties": false
}

ErrorResponse

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

日本語名	英字名	説明	Nullデータ
ステータスコード	status	ステータスコード	(※1)
メッセージ	message	ステータスコードに紐づくメッセージ	(※1)
エラーコード	code	エラーコード	(※1)
開発者向け詳細メッセージ	developer_message	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
httpステータスコード	httpCode	httpステータスコードと同値	(※1)
httpステータスメッセージ	httpMessage	httpステータスコードの文字列	(※1)
詳細メッセージ	moreInformation	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
エラー種別	error	エラーの種別を表す文字列	(※1)
詳細メッセージ	error_description	開発者向けの詳細メッセージ	(※1)

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

{
    "properties": {
        "status": {
            "type": "string",
            "description": "ステータスコード"
        },
        "message": {
            "type": "string",
            "description": "メッセージ"
        },
        "code": {
            "type": "string",
            "description": "エラーコード"
        },
        "developer_message": {
            "type": "string",
            "description": "開発者向け詳細メッセージ"
        },
        "httpCode": {
            "type": "string",
            "description": "httpステータスコード"
        },
        "httpMessage": {
            "type": "string",
            "description": "httpステータスメッセージ"
        },
        "moreInformation": {
            "type": "string",
            "description": "詳細メッセージ"
        },
        "error": {
            "type": "string",
            "description": "エラー種別"
        },
        "error_description": {
            "type": "string",
            "description": "詳細メッセージ"
        }
    },
    "additionalProperties": false
}

Payroll400ErrorResponse

給与賞与振込申請エラーレスポンスオブジェクト

日本語名	英字名	説明	Nullデータ
申請日	appliedDate	申請した日付	(※1)
申請時刻	appliedTime	申請した時刻	(※1)
申請ステータス	appliedStatus	申請した結果	(※1)
エラーコード	errorCode	エラーコード	(※1)
エラー文言	errorInfo	エラー文言	(※1)
申請結果	payrollResult	申請結果詳細オブジェクト　参照	(※1)

日本語名	英字名	説明	Nullデータ
ステータスコード	status	ステータスコード	(※1)
メッセージ	message	ステータスコードに紐づくメッセージ	(※1)
エラーコード	code	エラーコード	(※1)
開発者向け詳細メッセージ	developer_message	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
httpステータスコード	httpCode	httpステータスコードと同値	(※1)
httpステータスメッセージ	httpMessage	httpステータスコードの文字列	(※1)
詳細メッセージ	moreInformation	開発者向けの詳細メッセージ	(※1)

日本語名	英字名	説明	Nullデータ
エラー種別	error	エラーの種別を表す文字列	(※1)
詳細メッセージ	error_description	開発者向けの詳細メッセージ	(※1)

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

{
    "properties": {
        "appliedDate": {
            "type": "string",
            "description": "申請日",
            "example": "2016-07-15"
        },
        "appliedTime": {
            "type": "string",
            "description": "申請時刻",
            "example": "13:23:04"
        },
        "appliedStatus": {
            "type": "string",
            "description": "ステータス",
            "example": "failed"
        },
        "errorCode": {
            "type": "string",
            "description": "エラーコード",
            "example": "APISFD5014"
        },
        "errorInfo": {
            "type": "string",
            "description": "エラー文言",
            "example": "振込明細にエラー分があるため申請できません"
        },
        "payrollResult": {
            "description": "申請結果",
            "$ref": "#\/definitions\/PayrollResultInfo"
        },
        "status": {
            "type": "string",
            "description": "ステータスコード",
            "example": "400"
        },
        "message": {
            "type": "string",
            "description": "メッセージ",
            "example": "不正なパラメータ"
        },
        "code": {
            "type": "string",
            "description": "エラーコード",
            "example": "ERR006"
        },
        "developer_message": {
            "type": "string",
            "description": "開発者向け詳細メッセージ",
            "example": "指定した口座からは振込できません。"
        },
        "httpCode": {
            "type": "string",
            "description": "httpステータスコード",
            "example": "401"
        },
        "httpMessage": {
            "type": "string",
            "description": "httpステータスメッセージ",
            "example": "Unauthorized"
        },
        "moreInformation": {
            "type": "string",
            "description": "詳細メッセージ",
            "example": "Not registered to plan"
        },
        "error": {
            "type": "string",
            "description": "エラー種別",
            "example": "invalid_client"
        },
        "error_description": {
            "type": "string",
            "description": "詳細メッセージ",
            "example": "client_id unauthorized"
        }
    },
    "additionalProperties": false
}

developer.portal.bk.mufg.jp

メニュー

給与賞与振込

給与賞与振込

パス

/

1) 引落口座として指定可能な口座

2) 利用可能な科目

3) 振込の単位

4) エラー時の応答について

/{acceptance_no}

1) 照会可能な受付明細

2) 照会の単位

定義