提供概要
API提供概要
APIによるアクセス方法はお客さまが接続を希望するサービスや連携システムに応じて2種類の接続方法をご用意しています。
パブリックアクセス
預金者に代わって銀行口座に対しAPIによりアクセスを行う場合 電子決済等代行業として認可された事業者へアクセスを認めるもの
プライベートアクセス
法人口座を保有している企業さまが自社口座に対してAPIによるアクセスを行う場合
提供API
-
更新系API（Read/Write APIs）とは
預金者の口座の振込や振替といった、預金者の口座の資金移動が含む取引等ができるAPIです。
-
参照系API（Read only APIs）とは
預金者の口座残高や入出金明細といった、預金者の口座情報を参照することができるAPIです。
| カテゴリ | API種別 | API | 概要 |
|---|---|---|---|
| 口座 | 参照系 | 口座一覧照会 | 保有する全ての口座情報一覧を照会 |
| 残高照会 | 保有する口座の残高情報を照会 | ||
| 入出金明細照会 | 指定した円普通預金口座の入出金明細情報を照会 | ||
| 振込入金明細照会 | 被仕向振込の入金明細情報を照会 | ||
| デビット取引明細照会 | 指定した円普通預金口座のデビット取引明細情報を照会 | ||
| 振込/振替 | 更新系 | 振込状況照会 | 仕向の振込の履歴・状況の照会 |
| 振込依頼結果照会 | 振込依頼、振込取消依頼の処理状態を照会 | ||
| 振込手数料事前照会 | 仕向の振込依頼の手数料を事前に照会 | ||
| 振込依頼 | 仕向の振込依頼の指示 | ||
| 振込取消依頼 | 振込予約、振込申請の取消依頼を指示 | ||
| つかいわけ口座間振替 | つかいわけ口座間の振替の指示 | ||
| 総合振込 | 更新系 | 総合振込状況照会 | 仕向の総合振込の履歴・状況の照会 |
| 総合振込依頼結果照会 | 総合振込依頼の処理状態を照会 | ||
| 総合振込手数料事前照会 | 仕向の総合振込依頼の手数料を事前に照会 | ||
| 総合振込依頼 | 仕向の総合振込依頼の指示 | ||
| 総合振込取消依頼 | 総合振込予約、総合振込申請の取消依頼を指示 | ||
| 振込入金口座 （バーチャル口座） |
参照系 | 振込入金口座一覧照会 | 発行済みの振込入金口座の一覧を照会 |
| 振込入金口座入金明細照会 | 入金口座または振込入金口座を指定し、該当する入金明細を照会 | ||
| 振込入金口座発行 | 振込入金口座の発行 | ||
| 振込入金口座状態変更 | 振込入金口座の状態変更（停止・再開・削除） | ||
| 振込入金口座解約申込 | 振込入金口座契約の解約申込 | ||
| イベント通知 （Webhook） |
イベント制御・ 通知（参照系） |
通知配信制御 | イベント通知(Webhook）の配信開始、配信停止を制御 |
| 振込入金口座 入金明細通知 | 振込入金口座に対する被仕向入金発生通知（法人、個人、個人事業主） | ||
| 振込入金口座 未送信明細取得 | イベント配信停止時に上記入金明細通知（未配信分）を取得 |
以降、接続事業者のニーズに合わせてAPIを開発継続。
API共通仕様
| アーキテクチャスタイル | REST |
|---|---|
| プロトコル | HTTPs（TLS1.2以上） |
| データ表現形式 | JSON |
| 認可プロトコル | OAuth2.0 ＆ OpenID Connect |
| バージョン管理 | Semantic Versioning 2.0.0 |
認可プロトコル
当社ではアクセストークンの取得に必要な認可プロトコルとしてOAuth2.0およびOpenID Connectを用意し、接続企業さまのシステム仕様に合わせた選択を可能としています。
OAuth2.0
OpenID Connect
