APIラインアップ
銀行APIラインアップ
更新系API（Read/Write APIs）
預金者の口座の振込や振替といった、預金者の資金移動が含む取引などができるAPIです。
【主な機能】
・振込/振替の照会・実行
・総合振込の照会・実行 など
参照系API（Read only APIs）とは
預金者の口座残高や入出金明細といった、預金者の口座情報を参照することができるAPIです。
【主な機能】
・口座情報の照会
・振込入金口座（バーチャル口座）の口座発行や入金明細の取得など
スタンダードAPI（無償）※2022年11月14日時点
| カテゴリ | API種別 | API | 概要 | 事例詳細 |
|---|---|---|---|---|
| 口座 | 参照系 | 口座一覧照会 | 保有する全ての口座情報一覧を照会 | |
| 残高照会 | 保有する口座の残高情報を照会 | |||
| 入出金明細照会 | 指定した円普通預金口座の入出金明細情報を照会 | |||
| 振込入金明細照会 | 被仕向振込の入金明細情報を照会 | |||
| Visaデビット取引明細照会 ※1 | 指定した円普通預金口座のVisaデビット取引明細情報を照会 | |||
| 振込/振替 | 更新系 | 振込状況照会 | 仕向の振込の履歴・状況の照会 | |
| 振込依頼結果照会 | 振込依頼、振込取消依頼の処理状態を照会 | |||
| 振込手数料事前照会 | 仕向の振込依頼の手数料を事前に照会 | |||
| 振込依頼 | 仕向の振込依頼の指示 | リンク | ||
| 振込取消依頼 | 振込予約、振込申請の取消依頼を指示 | |||
| つかいわけ口座間振替 | つかいわけ口座間の振替の指示 | |||
| 総合振込 | 更新系 | 総合振込状況照会 | 仕向の総合振込の履歴・状況の照会 | |
| 総合振込依頼結果照会 | 総合振込依頼の処理状態を照会 | |||
| 総合振込手数料事前照会 | 仕向の総合振込依頼の手数料を事前に照会 | |||
| 総合振込依頼 | 仕向の総合振込依頼の指示 | |||
| 総合振込取消依頼 | 総合振込予約、総合振込申請の取消依頼を指示 | |||
| 振込入金口座 （バーチャル口座） |
参照系 | 振込入金口座一覧照会 | 発行済みの振込入金口座の一覧を照会 | |
| 振込入金口座入金明細照会 | 入金口座または振込入金口座を指定し、該当する入金明細を照会 | |||
| 振込入金口座発行 | 振込入金口座の発行 | リンク | ||
| 振込入金口座状態変更 | 振込入金口座の状態変更（停止・再開・削除） | |||
| 振込入金口座追加名義設定 | 振込入金口座の追加名義設定（変更・削除） | |||
| 振込入金口座解約申込 | 振込入金口座契約の解約申込 | |||
| デビット | 参照系 | デビット情報照会 | 指定した円普通預金口座のデビット利用可能額、利用限度額を照会 | |
| デビット取引明細照会 | 指定した円普通預金口座のデビット取引明細情報を照会 | |||
| イベント通知 （Webhook） |
イベント制御・ 通知（参照系） |
通知配信制御 | イベント通知(Webhook）の配信開始、配信停止を制御 | リンク |
| 通知配信状況照会 | 指定した認証情報に紐づく事業者のイベント毎の配信状況を照会 | |||
| 振込入金口座 入金明細通知 | 振込入金口座に対する被仕向入金発生通知（法人、個人、個人事業主） | |||
| 振込入金口座 未送信明細取得 | イベント配信停止時に上記入金明細通知（未配信分）を取得 |
- ※1 新規ご利用開始のお客様は、Visa明細の他、マスターカード明細も取得可能なカテゴリ「デビット」のAPIをご利用ください。
以降、接続事業者のニーズに合わせてAPIを開発継続。
ビジネスの自動化・高度化を希望される場合
オプションAPI（有償）※2022年11月14日時点
| カテゴリ | API種別 | API | 概要 | 事例詳細 |
|---|---|---|---|---|
| 本人確認（個人） | KYC系（参照系） | 本人確認情報照会 | 本人確認情報を照会 | |
| 振込入金口座 | 参照系 | 振込入金口座_入金限度額設定 | 振込入金口座に入金限度額を設定・解除 | |
| 振込/振替 | 更新系 | 振込事前設定口座一覧照会 | 振込事前設定を行う口座の一覧を照会 | |
| 振込事前設定口座操作 | 振込事前設定の口座を登録・変更・削除 | リンク | ||
| 即時振替 | 更新系 | 即時振替依頼 | 顧客口座からの即時振替依頼を実行 | |
| 即時振替履歴照会 | 顧客口座の即時振替依頼の履歴を照会 | |||
| 即時振替同意状況照会 | 顧客口座の即時振替同意状況を照会 | |||
| 上記以外にもAPIの用意がございます。お客さまのビジネスニーズをお伺いしたうえでご提案いたします。 | ||||
お客さまだけの特別なAPIを希望される場合
カスタムAPI（有償）
| カテゴリ | API種別 | API | 概要 |
|---|---|---|---|
| お客さまの個別ニーズに応じたAPIを開発・ご提供も可能です。 | |||
※APIのご利用には所定の審査がございます。また、お客さまのご要望内容によってはご要望に沿えない場合がございます。
API共通仕様
| アーキテクチャスタイル | REST |
|---|---|
| プロトコル | HTTPs（TLS1.2以上） |
| データ表現形式 | JSON |
| 認可プロトコル | OAuth2.0 ＆ OpenID Connect |
| バージョン管理 | Semantic Versioning 2.0.0 |
認可プロトコル
当社ではアクセストークンの取得に必要な認可プロトコルとしてOAuth2.0およびOpenID Connectを用意し、接続企業さまのシステム仕様に合わせた選択を可能としています。
OAuth2.0
OpenID Connect
銀行API提供概要
銀行APIによるアクセス方法はお客さまが接続を希望するサービスや連携システムに応じて2種類の接続方法をご用意しています。
パブリックアクセス
預金者に代わって銀行口座に対しAPIによりアクセスを行う場合（電子決済など代行業として認可された事業者へアクセスを認めるもの）
プライベートアクセス
法人口座を保有している企業さまが自社口座に対してAPIによるアクセスを行う場合
銀行APIのご利用までは3STEP！
-
STEP1
ヒアリングシートの提出
銀行API接続ご希望メールをいただけましたら、当社より事前ヒアリングシートを送付いたします。必要事項をご記入のうえ、ご提出ください。
ご提出いただいた事前ヒアリングシートをもとに審査させていただきます。 -
STEP2
契約締結
当社審査終了後、API利用契約書およびAPI利用申込書を送付いたします。API利用申込書をご提出いただき、API利用契約を締結します。
-
STEP3
接続試験後、利用開始！
契約締結後に、開発環境ご利用のための情報を送信いたします。
開発および接続試験をお願いいたします。 接続試験完了後、本番環境ご利用のための情報を送付いたします。
