「銀行API」とは

APIとは、アプリケーション・プログラミング・インターフェースの略で、機能やデータを他のアプリケーションから呼び出すための接続口やその仕組みを指します。

銀行が公開するAPIは、銀行と外部の事業者との間を安全にデータ連携するための仕組みです。当社の銀行APIでは、お客さまの口座残高や入出金明細、口座の振込や振替などのAPIをご利用いただけます。

GMOあおぞらネット銀行では
銀行APIの仕様書をAPI開発者ポータルで公開しています。

API開発者ポータルはこちら

銀行APIでできること

銀行APIの主な機能

更新系API(Read/Write APIs)

預金者の口座の振込や振替といった、預金者の資金移動が含む取引などができるAPIです。
【主な機能】
・振込/振替の照会・実行
・総合振込の照会・実行 など

参照系API(Read only APIs)とは

預金者の口座残高や入出金明細といった、預金者の口座情報を参照することができるAPIです。
【主な機能】
・口座情報の照会
・振込入金口座(バーチャル口座)の口座発行や入金明細の取得など

例えばこんな使いかた1

経理コストを大幅に軽減!

手間のかかる入金照合作業をスムーズにし、経理コストを大幅に軽減できます。

通常の場合
  1. 毎日何度も銀行口座にログインし売掛金の入金明細を確認
  2. 入金明細をCSVファイルで保存し、自社の経理システムへ移動する
  3. 入金明細を自社の経理システムで売掛金と照合

経理担当者は、毎月多くの業務に追われることに…

銀行APIを利用した場合
自社システム内で入金明細が自動で取得できるため、消し込み処理がすぐ行えます。

節約できた時間や人的リソースで他の業務を行うことがができます。

例えばこんな使いかた2

新たなビジネスチャンスを!

銀行サービスと御社の事業を組み合わせて新たなビジネスの構築が可能に。

銀行APIを利用し、「振込」や「口座、請求書の発行」、「入金処理」など
様々な業務を自動化・高度化することで、御社の事業をさらに加速させることができます。

例1)御社口座への入金のリアルタイム検知により、御社ビジネスをより早いサイクルで回し、収益拡大に繋げます。
例2)人手では対応困難だった大量の振込処理や、振込前の複雑な判断もシステム化が可能となります。

銀行APIの仕様書の多くは、契約締結後でなければ閲覧することはできません。しかし、当社は契約不要で銀行APIの仕様を確認することができるため、社内でサービスの企画や立案、実際の開発工数の算出がしやすくなります

銀行APIコンセプト

革新的な銀行APIへの取り組み

「すべてはお客さまのために。No.1テクノロジーバンクを目指して」をコーポレートビジョンに掲げる当社は、銀行APIの提供にも同様のビジョンで取り組んでいます。接続される企業さまや開発されるエンジニアさま、そしてその先のお客さまの立場で銀行API公開コンセプトを定め、各種銀行APIの提供を行っています。

API公開のコンセプト

当社は、電子決済等代行業者さまだけでなく、より多くの企業さまの利便性向上に寄与するため、一般の事業会社さまにも銀行APIをご利用いただける環境を整え、以下の4つのコンセプトを前提に銀行APIの開発、順次公開を行っています。

  1. 接続企業さまのエンジニアが開発しやすい環境を整備します(開発者ポータル、仕様書公開、サンドボックス、SDK提供等)
  2. 接続企業さまの決裁者が判断しやすい環境を整備します(利用料・接続料無料、明快な接続申請等)
  3. 接続企業さまをご利用になるお客さまが安心して利用できる環境を整備します(接続企業事前チェック体制、セキュリティ仕様等)
  4. API提供を継続して進化させます(接続企業さまからのリクエストによりAPIを継続開発)

銀行API提供概要

銀行APIによるアクセス方法はお客さまが接続を希望するサービスや連携システムに応じて2種類の接続方法をご用意しています。

パブリックアクセス

預金者に代わって銀行口座に対しAPIによりアクセスを行う場合 電子決済等代行業として認可された事業者へアクセスを認めるもの

プライベートアクセス

法人口座を保有している企業さまが自社口座に対してAPIによるアクセスを行う場合

カテゴリ API種別 API 概要
口座 参照系 口座一覧照会 保有する全ての口座情報一覧を照会
残高照会 保有する口座の残高情報を照会
入出金明細照会 指定した円普通預金口座の入出金明細情報を照会
振込入金明細照会 被仕向振込の入金明細情報を照会
Visaデビット取引明細照会 指定した円普通預金口座のVisaデビット取引明細情報を照会
振込/振替 更新系 振込状況照会 仕向の振込の履歴・状況の照会
振込依頼結果照会 振込依頼、振込取消依頼の処理状態を照会
振込手数料事前照会 仕向の振込依頼の手数料を事前に照会
振込依頼 仕向の振込依頼の指示
振込取消依頼 振込予約、振込申請の取消依頼を指示
つかいわけ口座間振替 つかいわけ口座間の振替の指示
総合振込 更新系 総合振込状況照会 仕向の総合振込の履歴・状況の照会
総合振込依頼結果照会 総合振込依頼の処理状態を照会
総合振込手数料事前照会 仕向の総合振込依頼の手数料を事前に照会
総合振込依頼 仕向の総合振込依頼の指示
総合振込取消依頼 総合振込予約、総合振込申請の取消依頼を指示
振込入金口座
(バーチャル口座)
参照系 振込入金口座一覧照会 発行済みの振込入金口座の一覧を照会
振込入金口座入金明細照会 入金口座または振込入金口座を指定し、該当する入金明細を照会
振込入金口座発行 振込入金口座の発行
振込入金口座状態変更 振込入金口座の状態変更(停止・再開・削除)
振込入金口座解約申込 振込入金口座契約の解約申込
イベント通知
(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

銀行APIが体験できる
「sunabar -GMOあおぞらネット銀行API実験場-」

『sunabar』を利用することでサービスの検討段階でプロトタイプの検証や新たな事業提案などに
ご利用いただけるため、ビジネスチャンスが広がります。

「sunabar -GMOあおぞらネット銀行API実験場-」とは

サンドボックスを意味する「砂場」と、人が集いグラスを交わす「Bar」を組み合わせ 名付けました。この名の通り、「sunabar」は、実際に動かせる開発環境と開発者が集うコミュニティの2面を持ちます。現在世の中に存在するコミュニティは座学やセミナー形式のものが多く、実際に動かして確認できる開発環境は限定的です。No.1テクノロジーバンクを目指す当社は、国内銀行初の試みとして、本格的な銀行API実験環境である「sunabar -GMOあおぞらネット銀行API実験場-」を個人・法人のお客さまに開放いたします。また、合わせて開発者が集い、互いに刺激を受け・与えるコミュニティ「sunabarコミュニティ」の運営を行うことで、旧来の金融常識にとらわれず、インターネットの常識から金融に変革を起こ すトリガーとなりたいと考えています。

sunabarなら色々な銀行APIを無料でご利用いただけます。
まずは色々な銀行サービスを試してみませんか?

sunabar に対するSNSの声

コミュニティ

「sunabar」は、オンライン、オフラインの両方の活動で、エンジニアやクリエイターの輪をつなぎます。銀行APIはもちろんのこと、新たなFinTechサービスの誕生を支援するため、集まる方の感性を刺激し、コミュニケー ションの活発化に取り組みます。

sunabarの利用開始方法