{ "info": { "_postman_id": "54cf6338-5b0d-4ce6-bf97-33e5a31566f6", "name": "2. 法人", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "accounts", "item": [ { "name": "口座一覧照会", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json;charset=UTF-8" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "x-access-token", "value": "{{x-access-token}}" } ], "url": { "raw": "https://{{domain_name}}/{{type}}/v1/accounts", "protocol": "https", "host": [ "{{domain_name}}" ], "path": [ "{{type}}", "v1", "accounts" ] }, "description": "保有する全ての口座情報一覧を照会します" }, "response": [] }, { "name": "残高照会", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json;charset=UTF-8" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "x-access-token", "value": "{{x-access-token}}" } ], "url": { "raw": "https://{{domain_name}}/{{type}}/v1/accounts/balances", "protocol": "https", "host": [ "{{domain_name}}" ], "path": [ "{{type}}", "v1", "accounts", "balances" ], "query": [ { "key": "accountId", "value": "{{accountId}}", "disabled": true } ] }, "description": "保有する口座の残高情報を照会します\n口座IDを指定した場合、該当する口座の残高情報を照会します\n口座IDを指定しない場合、保有する口座全ての残高情報を照会します\n" }, "response": [] }, { "name": "入出金明細照会", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json;charset=UTF-8" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "x-access-token", "value": "{{x-access-token}}" } ], "url": { "raw": "https://{{domain_name}}/{{type}}/v1/accounts/transactions?accountId={{accountId}}&dateFrom={{dateFrom}}&dateTo={{dateTo}}&nextItemKey={{nextItemKey}}", "protocol": "https", "host": [ "{{domain_name}}" ], "path": [ "{{type}}", "v1", "accounts", "transactions" ], "query": [ { "key": "accountId", "value": "{{accountId}}" }, { "key": "dateFrom", "value": "{{dateFrom}}" }, { "key": "dateTo", "value": "{{dateTo}}" }, { "key": "nextItemKey", "value": "{{nextItemKey}}" } ] }, "description": "
指定した円普通預金口座の入出金明細情報を照会します
\n対象科目
\n円普通預金口座
\nなお、つかいわけ口座も円普通預金口座の入出金明細を照会可能とし
\nつかいわけ口座の口座IDが指定された場合で、紐付く入出金明細が存在しない場合は空のリストを返却します
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーを追加してリクエストしてください
\nソート順
\n取引の昇順
\n対象期間
\n指定した円普通預金口座の振込入金明細情報を照会します
\n※個人事業主のみ対象となり、個人は対象外となります
\n対象科目
\n円普通預金口座
\nつかいわけ口座や、証券コネクト等は対象外となります(指定時はエラー)
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーを追加してリクエストしてください
\nソート順
\n取引の昇順
\n対象期間
\n指定した円普通預金口座のVisaデビット取引明細情報を照会します
※本APIは非推奨となりました。将来のバージョンで削除予定のAPIとなります。
Visaデビット取引明細の照会は、デビット参照のデビット取引明細照会APIをご利用ください。
対象科目
\n円普通預金口座かつ、Visaデビットカードを現時点で保有している口座
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nただし、1回の検索で総件数が99,999件を超える照会はできません。それ以上の場合は「400 Bad Request」を返却します
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーを追加してリクエストしてください
\nソート順
\n取引の降順
\n対象期間
\nデビット情報照会を実施します。
requestDebitStatusを複数設定する場合は、以下のように設定を行ってください。
リクエスト例)
requestDebitStatus=01&requestDebitStatus=02
デビット取引明細照会を実施します。
" }, "response": [] } ] }, { "name": "transfer", "item": [ { "name": "振込状況照会", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json;charset=UTF-8" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "x-access-token", "value": "{{x-access-token}}" } ], "url": { "raw": "https://{{domain_name}}/{{type}}/v1/transfer/status?accountId={{accountId}}&queryKeyClass={{queryKeyClass}}", "protocol": "https", "host": [ "{{domain_name}}" ], "path": [ "{{type}}", "v1", "transfer", "status" ], "query": [ { "key": "accountId", "value": "{{accountId}}" }, { "key": "queryKeyClass", "value": "{{queryKeyClass}}" }, { "key": "applyNo", "value": "2020031600000007", "disabled": true } ] }, "description": "仕向の振込状況および履歴を照会します
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーを追加してリクエストしてください
\nソート順
\n振込照会対象期間区分の指定により下記となります
\n1:振込申請受付日 第1ソート:振込申請日昇順 第2ソート:振込申請番号昇順
\n2:振込指定日 第1ソート:振込指定日昇順 第2ソート:振込申請番号昇順
\n※振込照会対象期間区分の指定がない場合は、1:振込申請受付日と同じとします
\n対象期間
\n照会対象ステータス
\n申請中以降のステータスで照会が可能となります
\n依頼中、作成中の状態は照会対象外です
\n照会対象となる明細
\n振込・振替・およびその予約の履歴と状況が照会対象となります(APIからの依頼結果のみではありません)
\n定額自動振込契約によって自動登録された振込は照会対象となります
\n定額自動振込契約の申請状態と状況は対象外となります
\n振込依頼、振込取消依頼の処理状態を照会します
\n振込取消依頼をした場合は、最後の依頼の結果コードが照会対象となります
\n振込・振込予約を行うための依頼内容の事前チェックと手数料を照会します
\n最大99件まで登録可能
\n1件の場合通常の振込扱いとなり、2件以上で一括振込扱いとなります
\n合計振込手数料および個別振込手数料は、振込実行時までに手数料の改定や消費税の変更等が行われた場合は、当APIで返却した手数料とは異なる手数料が適用されることがあります
\n振込無料回数とポイントについては、算出から振込実行までの間に変動する可能性があるため、手数料算出時の計算対象から除外して返却されます
\n振込・振込予約を行うための依頼をします
\n最大99件まで登録可能
\n1件の場合通常の振込扱いとなり、2件以上で一括振込扱いとなります
\n振込・振込予約の取消を行うための依頼をします
\n取消対象ステータス
\n申請中以降のステータスで取消が可能です
\n依頼中、作成中の状態は取消対象外です
\n取消対象キー区分
\n取消対象の取引の内容について指定して下さい
\n取消対象キー区分と、取消対象の振込申請番号の状態がマッチしない場合は、「400 Bad Request」を返却します
\n振込・振替/一括振込の対象は2のみとなります
\n1、3、4は指定不可となります
\n重複した依頼
\n同一の受付番号(振込申請番号)への重複した依頼はできません
\nなお、前回の振込取消依頼が期限切れとなれば依頼は可能となります
\n仕向の総合振込状況および履歴を照会します
\n※個人事業主のみ対象となり、個人は対象外となります
\n取得上限件数
\n総合振込照会明細情報 500件(明細情報取得フラグが「False:取得しない」の場合)
\n総合振込明細情報 500件(明細情報取得フラグが「True:取得する」の場合)
\n1回のリクエストで照会できる明細は、総合振込照会明細情報または総合振込明細情報のいずれか最大500件です
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーまたは総合振込明細情報取得対象キーを追加してリクエストしてください
\nソート順
\n明細情報取得フラグが、「False:取得しない」のとき
\n振込照会対象期間区分の指定により下記となります
\n1:振込申請受付日 第1ソート:振込申請日昇順 第2ソート:振込申請番号昇順
\n2:振込指定日 第1ソート:振込指定日昇順 第2ソート:振込申請番号昇順
\n※振込照会対象期間区分の指定がない場合は、1:振込申請受付日と同じとします
\n明細情報取得フラグが、「True:取得する」のとき
\n明細番号の昇順
\n対象期間
\n照会対象ステータス
\n申請中以降のステータスで照会が可能となります
\n依頼中、作成中の状態は照会対象外です
\n照会対象となる明細
\n総合振込・およびその予約の履歴と状況が照会対象となります(APIからの依頼結果のみではありません)
\n振込依頼、振込取消依頼の処理状態を照会します
\n振込取消依頼をした場合は、最後の依頼の結果コードが照会対象となります
\n総合振込・総合振込予約を行うための依頼内容の事前チェックと手数料を照会します
\n※個人事業主のみ対象となり、個人は対象外となります\n合計振込手数料および個別振込手数料は、振込実行時までに手数料の改定や消費税の変更等が行われた場合は、当APIで返却した手数料とは異なる手数料が適用されることがあります
\nポイントについては、算出から振込実行までの間に変動する可能性があるため、手数料算出時の計算対象から除外して返却されます
\n総合振込・総合振込予約を行うための依頼をします
\n※個人事業主のみ対象となり、個人は対象外となります\n" }, "response": [] }, { "name": "総合振込取消依頼", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json;charset=UTF-8" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "x-access-token", "value": "{{x-access-token}}" } ], "body": { "mode": "raw", "raw": "{ \r\n\t\"accountId\":\"{{accountId}}\",\r\n\t\"cancelTargetKeyClass\":\"4\",\r\n\t\"applyNo\":\"2020031600000007\"\r\n}" }, "url": { "raw": "https://{{domain_name}}/{{type}}/v1/bulktransfer/cancel", "protocol": "https", "host": [ "{{domain_name}}" ], "path": [ "{{type}}", "v1", "bulktransfer", "cancel" ] }, "description": "総合振込の取消を行うための依頼をします
\n※個人事業主のみ対象となり、個人は対象外となります
\n取消対象ステータス
\n申請中以降のステータスで取消が可能です
\n依頼中、作成中の状態は取消対象外です
\n取消対象キー区分
\n取消対象の取引の内容について指定して下さい
\n取消対象キー区分と、取消対象の振込申請番号の状態がマッチしない場合は、「400 Bad Request」を返却します
\n総合振込の対象は4のみとなります
\n1、2、3は指定不可となります
\n重複した依頼
\n同一の受付番号(振込申請番号)への重複した依頼はできません
\nなお、前回の総合振込取消依頼が期限切れとなれば依頼は可能となります
\n発行済みの振込入金口座の一覧を照会します
\n※個人事業主のみ対象となり、個人は対象外となります
\nリクエストボディの振込入金口座IDリスト上限件数
\n500件
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次一覧キーを追加してリクエストしてください
\nソート順
\n発行日時 昇順
\nクエリパラメーター 最終入金日
\nクエリパラメーター 振込入金口座発行日
\nクエリパラメーター 有効期限
\nクエリパラメーター 入金口座ID、 振込入金口座IDの設定別の仕様
\n振込入金口座API認証情報
\n提携企業契約時は必須で、この値が設定されていない場合、銀行契約の一覧照会を返却します
\n振込入金口座の入金明細を照会します
\n※個人事業主のみ対象となり、個人は対象外となります
\n取得上限件数
\n500件
\n取得できる明細数が500に満たないときは取得できる明細のみを返却します
\n取得できる明細が存在しない場合は「200:OK」とし明細を返却しません
\nページング
\n2ページ目以降を照会する際は、初回と同じリクエスト内容に、初回レスポンスの次明細キーを追加してリクエストしてください
\nソート順
\n取引の昇順
\nソート順コードを指定することにより、ソート順を変更できます
\n対象期間
\n入金口座ID、振込入金口座IDの設定別の仕様
\n振込入金口座の発行を行います
\n※個人事業主のみ対象となり、個人は対象外となります
\n※銀行システムのメンテナンス時は本APIを実行することができないため、予め余分に振込入金口座を発行してプールしておくことをお勧めします
\n発行上限数
\n1リクエスト : 1000口座まで
\n追加名義カナを前につける際の半角スペースについて
\n追加名義カナの右側は1文字のみ許容します
\n「テストニュウキングチ 」
「テストニュウキングチ 」
追加名義カナの左側は許容しません
\n「テストニュウキングチ」
「 テストニュウキングチ」
連続スペースは許容しません
\n「テス トニュウ キングチ」
「テス トニュウキングチ」
振込入金口座の状態変更(停止・再開・削除)を行います
\n※個人事業主のみ対象となり、個人は対象外となります
\n状態変更上限数
\n1リクエスト : 100口座まで
\n振込入金口座契約の解約申込を行います
\n※個人事業主のみ対象となり、個人は対象外となります
\n解約は解約受付月の月末に行われます
\n