production
development
https://developer.api.bk.mufg.jp
Custom Gateway API Endpoint
パス
/
post /
給与賞与振込申請
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Content-Type
header で必須
string
Accept
header でオプション
string
CreatePayroll
body で必須
object
要求の例
応答の例
POST https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/
この操作を試してみる
/{acceptance_no}
get /{acceptance_no}
給与賞与振込受付明細照会
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-BTMU-Seq-No
header で必須
string
{
"minLength": 25,
"maxLength": 25
}Accept
header でオプション
string
acceptance_no
path で必須
string
{
"minLength": 12,
"maxLength": 12
}default
要求の例
応答の例
GET https://developer.api.bk.mufg.jp/btmu/corporation/trial/v1/me/payrolls/{acceptance_no}
この操作を試してみる
定義
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"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
}
{
"properties": {
"status": {
"type": "integer",
"description": "ステータスコード",
"format": "int32"
},
"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
}
{
"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": "integer",
"description": "ステータスコード",
"example": 400,
"format": "int32"
},
"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
}