第2.0版
株式会社 三井住友銀行
2018年8月
パソコンバンクWeb21「サーバー接続サービス」 接続仕様
(システムご担当者用)
パソコンバンクWeb21「サーバー接続サービス」の接続仕様について
当行のパソコンバンクWeb21「サーバー接続サービス」では、API接続基盤に(株)NTTデータのシステムを採用しております。 NTT データの API 接続基盤は、当行を含む複数の金融機関が採用しており、基本的に採用金融機関の API接続仕様は共通ですが、金融機関毎に一部差異があります。 サーバー接続サービスの API接続仕様も、NTTデータ制定の API仕様書の通りですが、同仕様書は採用金融機関で共通ゆえ、同仕様書には当行が提供していない APIが含まれる等、一部差異がありますので予めご留意ください。
【別紙】AnserBizSOL API連携サービスの内容解説
AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
OpenCanvas API開発者ポータル
https://portal.opencanvas.ne.jp/api
本ドキュメント
AnserBizSOL API連携サービス (直接企業連携)
解説書<API管理基盤編>
別紙
本ドキュメントの位置付けと内容
1
本ドキュメントの位置付けと内容
本ドキュメントは、「AnserBizSOL」とのAPI連携サービスを利用するにあたり、基本的と機
能とその仕様について解説します。
ドキュメント体系図は以下のとおりです。
※ https://portal.opencanvas.ne.jp/api
①AnserBizSOL API連携サービスの内容解説
AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
②AnserBizSOL APIインタフェース仕様(Web上に公開(※))
OpenCanvas API開発者ポータル
目次
2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
目次
本ドキュメントの位置付けと内容 .................................................................................. 1 目次 ...................................................................................................................... 2
第 1章 サービス概要 .................................................................................. 1-1
1.1 API連携サービス概要 .................................................................................. 1.1-1 1.1.1 API連携サービスとは ............................................................................................ 1.1-1 1.1.2 API連携サービスを利用するための対応事項......................................................... 1.1-2
1.2 サービス提供時間 ....................................................................................... 1.2-1 1.2.1 オンライン運転時間 ............................................................................................... 1.2-1 1.2.2 サービス時間 .......................................................................................................... 1.2-1
1.3 連携方式 ................................................................................................... 1.3-1 1.3.1 接続構成 ................................................................................................................. 1.3-1 1.3.2 プロトコル構成 ...................................................................................................... 1.3-2 1.3.3 連絡手段 ................................................................................................................. 1.3-2 1.3.4 OAuth認証 ............................................................................................................. 1.3-3 1.3.5 API連携 .................................................................................................................. 1.3-5 1.3.6 API連携の上限値 ................................................................................................... 1.3-8 1.3.7 接続先 URL ............................................................................................................ 1.3-9
1.4 試験環境 ................................................................................................... 1.4-1 1.4.1 開発者ポータル環境 ............................................................................................... 1.4-1 1.4.2 接続試験環境 .......................................................................................................... 1.4-1
第 2章 通信制御........................................................................................ 2-1
2.1 連携手順 ................................................................................................... 2.1-1 2.1.1 企業による API連携概要フロー ............................................................................ 2.1-1
2.2 同時利用制御 ............................................................................................ 2.2-1 2.2.1 パスによる同時利用制御 ........................................................................................ 2.2-1
2.3 タイマ管理 ................................................................................................. 2.3-1 2.3.1 AnserBizSOLでのタイマ監視 ................................................................................ 2.3-1 2.3.2 企業様におけるタイマ監視 .................................................................................... 2.3-1
第 3章 利用開始後の手続き ........................................................................ 3-1
3.1 API連携サービス利用開始後の手続き ............................................................ 3.1-1 3.1.1 API連携サービス利用開始後の手続き ................................................................... 3.1-1
第 4章 通信シーケンス ............................................................................... 4-1
4.1 API連携サービスの通信フロー ...................................................................... 4.1-1 4.1.1 API連携サービス利用時の基本フロー ................................................................... 4.1-1
4.2 正常時の通信シーケンス .............................................................................. 4.2-1 4.2.1 API連携認証~アクセストークン取得 ................................................................... 4.2-1 4.2.2 アクセストークン再発行 ........................................................................................ 4.2-3 4.2.3 基本情報照会 .......................................................................................................... 4.2-4 4.2.4 照会(リアルタイム系) ........................................................................................ 4.2-5
目次
3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.5 照会(伝送系) ...................................................................................................... 4.2-6 4.2.6 依頼データ登録(承認なし) ................................................................................. 4.2-7 4.2.7 依頼データ登録(承認あり) ................................................................................. 4.2-8 4.2.8 トークン失効 ........................................................................................................ 4.2-10
4.3 異常時の通信シーケンス .............................................................................. 4.3-1 4.3.1 異常時処理の概要 ................................................................................................... 4.3-1 4.3.2 API連携認証・認可時のエラー .............................................................................. 4.3-2 4.3.3 依頼データ登録要求時のエラー ............................................................................. 4.3-4 4.3.4 依頼データ登録要求時の警告 ................................................................................. 4.3-5
第 5章 通信インタフェース仕様 ..................................................................... 5-1
5.1 API連携サービス用接続先 URL .................................................................... 5.1-1 5.1.1 API連携サービス用接続先 URL ............................................................................ 5.1-1
5.2 電文フォーマット .......................................................................................... 5.2-1 5.2.1 企業 URL入力画面表示 ......................................................................................... 5.2-1 5.2.2 認可結果画面取得要求 ............................................................................................ 5.2-2
5.3 異常応答電文エラーコード一覧 ..................................................................... 5.3-1 5.3.1 異常応答電文エラーコード一覧 ............................................................................. 5.3-1
5.4 通信インタフェース補足 ................................................................................ 5.4-1 5.4.1 残高照会応答電文の自動変換について ................................................................... 5.4-1
5.5 企業識別子の暗号化方式 ............................................................................. 5.5-2 5.5.1 企業認証識別子の暗号化方式 ................................................................................. 5.5-2
付録
付録1.全銀テレ為替文字
付録2.全銀テレ為替文字変換
付録3.システム規定半角文字
付録4.システム規定全角文字
付録5.取引可能期間チェック
付録.総合振込業務の振込可能期間チェック 付録.給与・賞与振込業務の振込可能期間チェック 付録.口座振替業務の取引可能期間チェック
付録6.送信メール
第 1章 サービス概要
1-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
第1章 サービス概要
第 1章 サービス概要
1.1-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.1 API連携サービス概要
1.1.1 API連携サービスとは API連携サービスとは、AnserBizSOLにて利用者を認証し、その認可状態をAnserBizSOL利用
企業様に委譲することで、AnserBizSOLにて利用できる照会や資金移動の機能の提供を可能と
するサービスです。企業様は、AnserBizSOLから取得した情報を各自が提供するアプリケーシ
ョンやWEBサービス(以降、企業様API連携接続システム)に活用し、利用者へ提供すること
が可能です。
図 1.1.1-1 API連携サービスの概要図
API
管理基盤
利
用
者
Anser
BizSOL
取引データ
(明細、残高)
金融機関
取引データ
(明細、残高)
③ANSER電文に
企業様
取引データ
(明細、残高)
②認可情報に基づく連携
⑥表示
①表示依頼
④取引情報報告
よる取引依頼
⑤取引情報連携
IF変換
第 1章 サービス概要
1.1-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.1.2 API連携サービスを利用するための対応事項 以下に、企業様のシステム部と財務部において必要な対応事項を示します。
表 1.1.2-1 各システムの役割分担
部署名 対応事項 システム部 <必要機器の手配>
・インターネットに接続可能なパソコン(既存のインターネット接続可能なパソコ
ンも流用可)
・API連携用サーバ
・インターネット回線
<アプリケーション開発>
本サービスは、入出金明細照会や資金移動など、API連携を実現するため
の、認証および APIインタフェースのご提供となります。API連携サービスをご
利用いただく際には、APIインタフェースにもとづき、企業様サーバでのアプリ
ケーション開発が必要となります。
<事前設定>
API連携に必要な以下の設定情報を企業様サーバに設定いただく必要があり
ます。
・クライアントID
・暗号化キー
・クライアントパスワード
財務部 <インターネットバンキングのご契約>
API連携サービスは、インターネットバンキングサービスのご利用が前提となり
ます。API連携サービスを利用される口座については、インターネットバンキン
グならびにAPI連携サービスのご契約をお願いします。
企業様にて設定いただくクライアント ID、暗号化キー、クライアントパスワードはセキュリ
ティ対策を万全に講じ、厳重に管理ください。
第 1章 サービス概要
1.2-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.2 サービス提供時間
1.2.1 オンライン運転時間 オンライン運転時間の範囲内でAnserBizSOLと関連サービスを利用できます。
AnserBizSOLと関連サービスのオンライン運転時間は、下表のとおりです。
表 1.2-1 オンライン運転時間
サービス名称 運転時間 定期休止日(非運転日) 定期休止時間帯(非運転時間帯)
AnserBizSOL
(商用環境、
接続試験環境)
0:00~24:00
(※3)
1/1~1/3、
5/3~5/5 0:00~24:00
第1月曜日2:00~6:00
第3月曜日2:00~6:00
ハッピーマンデー(※1)の前日21:00~翌
6:00(※2)
開発者ポータル
環境
0:00~24:00 なし(※4) 1/1~1/3 0:00~8:00、19:00~24:00(※5)
5/3~5/5 2:00~6:00
第1月曜日2:00~6:00
第3月曜日2:00~6:00
※1 成人の日(1月の第2月曜日)、海の日(7月の第3月曜日)、敬老の日(9月の第3月曜日)、体育の日(10月の第2
月曜日)
※2 定期休止時間帯と重なった場合、ハッピーマンデーの特別休止時間帯を有効とする。
※3 日曜日と祝日が重なった場合には日曜日運転とする。例:12/23(日)祝日、12/24(月)振替休日の場合には、
12/23(日)は日曜日運転、12/24(月)は祝日運転
※4 不特定の休止日、休止時間帯を設定する場合は、事前に通知する。
※5 1/1~1/3の8:00~19:00を定期休止時間帯(非運転時間帯)とする場合は、事前に通知する。
1.2.2 サービス時間 AnserBizSOLのオンライン運転時間の範囲内で、業務ごとにAPI連携サービスの利用可能時間
が設定されています。詳細な利用可能時間については、金融機関が事前申込にて設定している
ので、金融機関へ確認すること。
表 1.2-2 API連携サービスの利用可能時間(1/2)
項番 電文名 利用可能時間 1 API連携認証 ログイン可能時間
2 照会用暗証番号の登録(※1) 残高照会可能時間
3 リダイレクト(コールバック) ログイン可能時間
4 アクセストークン取得・再発行要求/応答 ログイン可能時間
5 トークン失効要求/応答 ログイン可能時間
6 企業情報照会要求/応答 ログイン可能時間
7 利用者情報照会要求/応答 ログイン可能時間
8 残高照会(全口座)要求/応答 残高照会可能時間
9 残高照会(口座指定)要求/応答 残高照会可能時間
10 入出金明細照会(ANSER)要求/応答 入出金明細照会(ANSER)可能時間
11 入出金明細照会(全銀)要求/応答 入出金明細照会(全銀)可能時間
12 振込入金明細照会(ANSER)要求/応答 振込入金明細照会(ANSER)可能時間
13 振込入金明細照会(全銀)要求/応答 振込入金明細照会(全銀)可能時間
第 1章 サービス概要
1.2-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 1.2-2 API連携サービスの利用可能時間(2/2)
項番 利用サービス 利用可能時間 14 口座振替結果照会要求/応答 口座振替種類n可能時間(※2)
15 口座振替手数料照会要求/応答 口座振替種類n可能時間(※2)
16 振込振替依頼データ登録要求/応答 振込振替可能時間
17 総合振込依頼データ登録要求/応答 総合振込可能時間
18 給与・賞与振込依頼データ登録要求/応答 給与・賞与振込可能時間
19 口座振替依頼データ登録要求/応答 口座振替種類n可能時間(※2)
20 振込振替依頼データ照会要求/応答
21 実行済/承認済取引データ 振込振替照会可能時間
22 未実行/未承認取引データ 振込振替可能時間
23 総合振込依頼データ照会要求/応答 総合振込可能時間
24 給与・賞与振込依頼データ照会要求/応答 給与・賞与振込可能時間
25 口座振替依頼データ照会要求/応答 口座振替種類n可能時間(※2)
26 振込振替依頼データ承認要求/応答 振込振替可能時間
27 総合振込依頼データ承認要求/応答 総合振込可能時間
※1 金融機関が事前申込にて、“利用者による照会用暗証番号を入力する”と設定している場合
※2 nには1~5までの数字が入り、それぞれ口座振替種類1~5に対応する
第 1章 サービス概要
1.3-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3 連携方式
1.3.1 接続構成 AnserBizSOLセンタ、企業様API連携接続システムおよび、利用者端末の接続方式には、OAuth
認証とAPI連携があります。それぞれの用途、概要を以下に示します。
表 1.3.1-1 接続方式一覧
項番 接続方式 用途/概要 1 OAuth認証(※1) 利用者端末が AnserBizSOLと接続するため、インターネットや
ISPが提供するネットワークを利用して利用者を認証し、認可状
態の委譲を行う接続方式。
SSLによる暗号化を行い、高い安全性を確保する。
2 API連携 利用者端末を経由せず、企業様 API連携接続システムと
AnserBizSOL間でインターネットを利用して通信を行う接続方
式。
OAuth認証と同様に SSLによる暗号化を行い、高い安全性を
確保する。
※1:本サービスでは、OAuth2.0プロトコルを使用する。
接続構成の概要図は以下のとおりです。
図 1.3.1-1 接続構成の概要図
ANSERセンタ
API管理基盤 Anser
BizSOL
企業様
OAuth認証での通信
API連携での通信
ファイアウォール
利用者端末
(ブラウザ、スマートフォン)
API連携接続
システム
会計システム
給与システム
etc
OAuth認証
API連携、アクセストークン管理を実施する
API連携
インターネットに接続可能な端末
第 1章 サービス概要
1.3-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3.2 プロトコル構成 API連携インタフェースで使用するプロトコルの構成を以下に示します。
OSI参照モデル OAuth認証電文・API連携電文
アプリケーション層 本書で規定する電文フォーマット
プレゼンテーション層
HTTP over SSL/TLS(HTTP/1.0またはHTTP1.1) セッション層
トランスポート層 TCP
ネットワーク層 IP
データリンク層 規定しない
物理層
図 1.3.2-1 プロトコル構成
1.3.3 連絡手段 本連携手順においては、AnserBizSOLと企業様間の連絡手段として、「リダイレクト」を利用
します。これらの連絡手段に対して、電文と呼ばれる制御メッセージを設定することで、
AnserBizSOLと企業様API連携接続システムとの間で情報のやり取りを行います。
(1)リダイレクト
業務上で発生するAnserBizSOLの画面と企業様API連携接続システムの画面との間の相互移行
(利用者ブラウザから見たAnserBizSOLと連携先アプリケーションとの接続替え)は、インタ
ーネットおよび利用者のブラウザを経由した「リダイレクト」により実現します。(単純な
URLリンクは、双方のサーバにおける端末入力待ちタイマの監視を阻害することから、使用し
ません。)
一方のサーバが、他方のサーバへ画面を移行する際には、そのHTTPレスポンスにおいて、HTTP
ヘッダのLocationフィールドに接続先のURLをセットすることにより、他サーバへの接続を
ブラウザに指示します。
図 1.3.3-1 リダイレクト
利用者端末(ブラウザ、スマートフォン)
企業様API連携接続システム ANSERセンタ
インターネット
HTTPリクエスト
HTTPレスポンス
HTTPリクエスト
リダイレクト
第 1章 サービス概要
1.3-3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3.4 OAuth認証 OAuth認証とは、企業様からの要求により、AnserBizSOLにて利用者の認証および企業様に情
報を連携することへの認可を行うための認証プロトコルです。
(1)リダイレクト
企業様とAnserBizSOL間でのリダイレクト電文を用いて通信を行います。以下に、OAuth認証
における電文の用途と通信契機を示します。
表 1.3.4-1 リダイレクト電文の用途・送信契機
項番 電文種別名 用途(設定内容)・送信契機 1 API連携認証電文
(企業様からAnserBizSOLへ
遷移)
企業様は、利用者に認証・認可を行ってもらうため、利用者端
末、API管理基盤を経由して自動的(リダイレクト )に
AnserBizSOLへ電文を送信する。
2 リダイレクト(コールバック)電
文
(AnserBizSOLから企業様へ
遷移)
AnserBizSOLは、利用者が行った認証・認可の結果を応答する
ため、利用者端末を経由して自動的(リダイレクト)に企業様へ
電文を送信する。
ただし、利用者による認証・認可の中止時やエラー発生時は、
利用者端末に中止またはエラーの画面を応答し、企業様へは
画面からの処理要求に応答内容を付加して送信する。
(2)トークン
利用者による認証と認可の完了後、企業様はAnserBizSOLに対してトークンの発行を依頼しま
す。なお、トークンの発行依頼については、表 1.3.4-2を参照してください。
表 1.3.4-2 OAuth電文の用途・送信契機
項番 電文種別名 用途(設定内容)・送信契機 1 アクセストークン取得・再発行
要求電文
企業様が、API管理基盤を介して AnserBizSOLに対してアクセ
ストークンの発行・再発行を依頼する際に送信する。
2 アクセストークン取得・再発行
応答電文
アクセストークン取得・再発行要求電文の応答として、
AnserBizSOLが、API管理基盤を介して企業様に対して、発行
したアクセストークン、リフレッシュトークン、およびトークンを発
行した利用者情報を設定して送信する。
3 異常応答電文 各要求電文の応答として、AnserBizSOLが企業様に対して、
AnserBizSOL内で応答電文送信前にエラーが発生した場合の
エラーコードを設定して送信する。
第 1章 サービス概要
1.3-4 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
AnserBizSOLから発行されるトークンは以下のとおりです。なお、照会・依頼データ確定用の
トークンと、承認用のトークンは別で発行する必要があります。
表 1.3.4-3 API連携サービスで利用するトークンの種類
項番 トークン名 有効期限 説明 1 アクセス
トークン
・15分
(固定)
保護されたリソースにアクセスするために使用されるクレデンシ
ャル。
企業からAnserBizSOLに対してAPI連携を要求する際、有効な
アクセストークンを提示することで利用者の認証および認可が
完了しているものとする。
2 リフレッシュ
トークン
・都度
・一定期間
・無制限(※)
アクセストークンを取得するために使用されるクレデンシャル。
初回・依頼データ確定用のトークンの有効期限と承認用のトー
クンの有効期限は利用者がそれぞれ設定できる。
アクセストークンが有効期限切れかつリフレッシュトークンが有
効期間内の場合、リフレッシュトークンを提示してトークンの再
発行を依頼することで、利用者の認証および認可を行わずに
新しいアクセストークンおよびリフレッシュトークンの発行が可
能である。
なお、両方のトークンが有効期限切れの場合は、再度利用者
の認証および認可が必要となる。
※ 無制限を選択する場合は、トークンの不正利用がないことを確認するためのヘルスチェック機能などを実装することを推
奨する。
(3)トークンの自動初期化
アクセストークン、リフレッシュトークンは、利用者によるAnserBizSOLの画面操作(利用者
端末操作)、金融機関によるAnserBizSOLの管理画面操作(運用端末操作)により、自動初期
化される場合があります。詳細は、以下の通りです。
表 1.3.4-4 トークンの自動初期化の契機
項番 操作対象 自動初期化の契機 対象者 1 利用者端末操作 ログインID変更時 当該利用者
2 利用者情報の削除時
3 API連携接続情報の変更時
(クライアントパスワードまたは暗号化キーの変更)
企業内の全利用者
4 利用者端末操作
/運用端末操作
ログインパスワード変更時(※1) 当該利用者
※1 運用端末操作時において、画面入力によるログインパスワードの変更のみが初期化の対象となり、契約ファイルによ
るログインパスワードの変更時はAPI連携認証の自動初期化の対象外となる。
第 1章 サービス概要
1.3-5 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3.5 API連携 API連携は、企業様からAPI管理基盤に対して、資金移動の依頼や残高照会、明細の照会、取
引状況の照会、または依頼に対するAPI管理基盤から企業様への結果返却を行うための通信プ
ロトコルです。API管理基盤は、バックエンドでAnserBizSOLと通信し、結果を返却します。
API連携は、API管理基盤に対する依頼ごとに、「要求電文」と「応答電文」の組合せで通信
を行います。以下に、API連携における電文の用途と通信契機を示します。
表 1.3.5-1 API連携電文の用途・送信契機(共通)
項番 電文種別名 用途(設定内容)・送信契機 1 トークン失効要求電文 企業様が、API管理基盤を介しAnserBizSOLに対して認証状態
の解除を依頼する際に送信する。
2 トークン失効応答電文 トークン失効要求電文の応答として、AnserBizSOLが、API管
理基盤を介し企業様に対してトークン失効要求の結果を設定し
て送信する。
3 企業情報照会要求電文 企業様が、API管理基盤を介しAnserBizSOLに対して、対象企
業の資金移動業務で承認に必要な情報の照会を依頼する際
に送信する。
4 企業情報照会応答電文 企業情報照会要求電文の応答として、AnserBizSOLが、API管
理基盤を介し企業様に対して要求電文で指定された企業の資
金移動業務で必要となる承認者情報(承認者名、取引あたりの
限度額、明細あたりの限度額)を送信する。
5 利用者情報照会要求電文 企業様が、API管理基盤を介しAnserBizSOLに対して利用者が
利用可能な全口座、および利用者の各業務の利用権限の保持
状態の照会を依頼する際に送信する。
6 利用者情報照会応答電文 利用者情報照会要求電文の応答として、AnserBizSOLが、API
管理基盤を介し企業様に対して要求電文で指定された利用者
の利用可能口座、利用可能業務権限および取引可能な明細上
限件数を送信する。
7 異常応答電文 各要求電文の応答として、AnserBizSOLが企業様に対して、
AnserBizSOL内で応答電文送信前にエラーが発生した場合の
エラーコードを設定して送信する。
表 1.3.5-2 API連携電文の用途・送信契機(明細照会)(1/2)
項番 電文種別名 用途(設定内容)・送信契機 1 残高照会(全口座)要求電文 企業様が、API管理基盤を介しAnserBizSOLに対して利用者の
利用可能な全口座の残高照会を依頼する際に送信する。
2 残高照会(全口座)応答電文 残高照会(全口座)要求電文の応答として、AnserBizSOLが、
API管理基盤を介し企業様に対して要求電文で利用者の利用
可能な全口座の残高を送信する。
3 残高照会(口座指定)要求電
文
企業様が、API管理基盤を介しAnserBizSOLに対して指定口座
の残高照会を依頼する際に送信する。
4 残高照会(口座指定)応答電
文
残高照会(口座指定)要求電文の応答として、AnserBizSOL
が、API管理基盤を介し企業様に対して要求電文で指定された
口座の残高を送信する。
5 入出金明細照会(ANSER)要
求電文
企業様が、API管理基盤を介しAnserBizSOLに対して入出金明
細照会(ANSER)を依頼する際に送信する。
6 入出金明細照会(ANSER)応
答電文
入出金明細照会 ( ANSER)要求電文の応答 と して 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
で指定された口座の入出金明細(ANSER)を送信する。
7 入出金明細照会(全銀)要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して入出金明
細照会(全銀)を依頼する際に送信する。
8 入出金明細照会(全銀)応答
電文
入出金明細照会(全銀)要求電文の応答として、AnserBizSOL
が、API管理基盤を介し企業様に対して要求電文で指定された
口座の入出金明細(全銀)を送信する。
第 1章 サービス概要
1.3-6 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 1.3.5-2 API連携電文の用途・送信契機(明細照会)(2/2)
項番 電文種別名 用途(設定内容)・送信契機 9 振込入金明細照会(ANSER)
要求電文
企業様が、API管理基盤を介しAnserBizSOLに対して振込入金
明細照会(ANSER)を依頼する際に送信する。
10 振込入金明細照会(ANSER)
応答電文
振込入金明細照会(ANSER)要求電文の応答として、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
で指定された口座の振込入金明細(ANSER)を送信する。
11 振込入金明細照会(全銀)要
求電文
企業様が、API管理基盤を介しAnserBizSOLに対して振込入金
明細照会(全銀)を依頼する際に送信する。
12 振込入金明細照会(全銀)応
答電文
振込入金明細照会要求 (全銀 )電文の応答として 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
で指定された口座の振込入金明細(全銀)を送信する。
13 口座振替結果照会要求電文 企業様が、API管理基盤を介しAnserBizSOLに対して口座振替
結果照会を依頼する際に送信する。
14 口座振替結果照会応答電文 口座振替結果要求電文の応答として、AnserBizSOLが、API管
理基盤を介し企業様に対して要求電文で指定された口座振替
の結果を送信する。
15 口座振替手数料照会要求電
文
企業様が、API管理基盤を介しAnserBizSOLに対して口座振替
手数料照会を依頼する際に送信する。
16 口座振替手数料照会応答電
文
口座振替手数料照会要求電文の応答として、AnserBizSOL
が、API管理基盤を介し企業様に対して要求電文で指定された
口座振替手数料を送信する。
表 1.3.5-3 API連携電文の用途・送信契機(資金移動)
項番 電文種別名 用途(設定内容)・送信契機 1 振込振替依頼データ登録要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して振込振替
(承認あり)の取引確定、振込振替(承認なし)の取引の一時保
存を依頼する際に送信する。
2 振込振替依頼データ登録応答
電文
振込振替依頼デー タ登録要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。また、AnserBizSOLでの処理時にエラー
(警告)となった場合は、エラー(警告)情報を送信する。
3 総合振込依頼データ登録要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して総合振込
の依頼データの登録をする際に送信する。
4 総合振込依頼データ登録応答
電文
総合振込依頼デー タ登録要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。また、AnserBizSOLでの処理時にエラー
(警告)となった場合は、エラー(警告)情報を送信する。
5 給与・賞与振込依頼データ登
録要求電文
企業様が、API管理基盤を介し AnserBizSOLに対して給与・賞
与振込の取引確定を依頼する際に送信する。
6 給与・賞与振込依頼データ登
録応答電文
給与・賞与振込依頼データ登録要求電文の応答として、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。また、AnserBizSOLでの処理時にエラー
(警告)となった場合は、エラー(警告)情報を送信する。
7 口座振替依頼データ登録要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して口座振替
の取引確定を依頼する際に送信する。
8 口座振替依頼データ登録要求
電文
口座振替依頼デー タ登録要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。また、AnserBizSOLでの処理時にエラー
(警告)となった場合は、エラー(警告)情報を送信する。
第 1章 サービス概要
1.3-7 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 1.3.5-4 API連携電文の用途・送信契機(取引照会)
項番 電文種別名 用途(設定内容)・送信契機 1 振込振替依頼データ照会要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の振
込振替の取引状況照会を依頼する際に送信する。
2 振込振替依頼データ照会応答
電文
振込振替依頼デー タ照会要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
3 総合振込依頼データ照会要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の総
合振込の取引状況照会を依頼する際に送信する。
4 総合振込依頼データ照会応答
電文
総合振込依頼デー タ照会要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
5 給与・賞与振込依頼データ照
会要求電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の給
与・賞与振込の取引状況照会を依頼する際に送信する。
6 給与・賞与振込依頼データ照
会応答電文
給与・賞与振込依頼データ照会要求電文の応答として、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
7 口座振替依頼データ照会要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の口
座振替の取引状況照会を依頼する際に送信する。
8 口座振替依頼データ照会応答
電文
口座振替依頼デー タ照会要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
表 1.3.5-5 API連携電文の用途・送信契機(承認)
項番 電文種別名 用途(設定内容)・送信契機 1 振込振替依頼データ承認要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の振
込振替の承認依頼する際に送信する。
2 振込振替依頼データ承認応答
電文
振込振替依頼デー タ承認要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
3 総合振込依頼データ承認要求
電文
企業様が、API管理基盤を介しAnserBizSOLに対して対象の総
合振込の承認依頼する際に送信する。
4 総合振込依頼データ承認応答
電文
総合振込依頼デー タ承認要求電文の応答 と し て 、
AnserBizSOLが、API管理基盤を介し企業様に対して要求電文
の結果を送信する。
図 1.3.5-1 API連携電文による通信のイメージ
API連携事業者 AnserBizSOL
①XXXX要求電文
②XXXX応答電文
API管理基盤
第 1章 サービス概要
1.3-8 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3.6 API連携の上限値 API連携電文のうち、上限値は以下の通りとなります。
表 1.3.6-1 API連携電文の上限値
項番 電文種別名 上限値(※1) 1 残高照会(全口座)要求/応答 100口座/回(※2)(※3)
2 残高照会(口座指定)要求/応答 100口座/回(※2)(※3)
3 入出金明細照会(ANSER)要求/応答 999明細/回(※2)
4 振込入金明細照会(ANSER)要求/応答 999明細/回(※2)
5 入出金明細照会(全銀)要求/応答 20,000明細/回
6 振込入金明細照会(全銀)要求/応答 20,000明細/回
7 口座振替結果照会要求/応答 20,000明細/回(※4)
8 口座振替手数料照会要求/応答 40明細/回(※2)
9 振込振替依頼データ登録要求/応答 1明細/回
10 振込振替依頼データ照会要求/応答
11 総合振込依頼データ登録要求/応答 20,000明細/回(※4)
12 総合振込依頼データ照会要求/応答
13 給与・賞与振込依頼データ登録要求/応答 20,000明細/回(※4)
14 給与・賞与振込依頼データ照会要求/応答
15 口座振替依頼データ登録要求/応答 20,000明細/回(※4)
16 口座振替依頼データ照会要求/応答
17 振込振替依頼データ承認要求/応答 1取引/回
18 総合振込依頼データ承認要求/応答
※1 本項の上限値は、AnserBizSOL内での上限値となる。金融機関ホストの仕様にて、本項の上限値以下とする制約があ
る場合は、金融機関ホストの制約に従う。
※2 AnserBizSOLと同様
※3 金融機関の設定にて、残高照会対象口座選択方式を複数の口座を選択するとしている場合、金融機関ホストの仕様
に従うため、金融機関への確認が必要となる。
※4 上限値設定パターンが20,000 明細以下の場合は、上限値設定パターンが上限となる。
第 1章 サービス概要
1.3-9 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.3.7 接続先 URL 企業様からAPI管理基盤へ通信する際の接続先URL例を以下に示します。
図 1.3.7-1 接続先URLの例
※1 ドメインは環境ごとに変わる。
表 1.3.7-1 ドメイン一覧
項番 環境 ドメイン 1 開発者ポータル環境 sample.apigw.opencanvas.ne.jp
2 接続試験環境 test.apigw.opencanvas.ne.jp
3 商用環境 www.apigw.opencanvas.ne.jp
※2 バージョンについては、メジャーバージョンを設定する。
※3 直接企業連携による接続の場合、「DIRECT=ON」の設定が必須となる。
ドメイン(※1)
システム名(固定値)
バージョン情報(※2)
金融機関コード
API個別
直接企業連携パラメータ(固定値)
(※3)
https://www.apigw.opencanvas.ne.jp/bizsol/v1/banks/{bank_code}/oauth/auth・・・?DIRECT=ON&・・・
第 1章 サービス概要
1.4-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
1.4 試験環境
AnserBizSOLでは試験環境として、以下の試験環境を提供する。
1.4.1 開発者ポータル環境 API管理基盤内のAnserBizSOLシミュレータと接続し、リクエストパターンに基づいていくつ
かのサンプルデータを返却する環境である。
AnserBizSOLや金融機関システムと接続する前に企業様が検証やサービスの簡単な動作確認
を行えるように用意しており、サービス提供時間内であれば自由に使用することができる。リ
クエストパターンについては『OpneCanvas API開発者ポータル』(https://portal.opencan
vas.ne.jp/api)参照。
API連携サービスにて提供されるAPI仕様は金融機関や利用者ごとに要求や応答の設定値が異
なるため、それらを考慮した試験が必要な場合は接続試験環境を使用すること。
図 1.4.1-1 開発者ポータル環境
1.4.2 接続試験環境 AnserBizSOLでは、金融機関が AnserBizSOLの各機能を商用環境提供前に確認できるように、
試験専用の環境である接続試験環境を提供している。接続試験環境はAnserBizSOLを経由して
金融機関システムを含めた外部センタと接続しているため、使用にあたっては、事前に金融機
関との調整および金融機関による接続試験申込が必要となる。
図 1.4.2-1 接続試験環境
API
管理基盤
Anser
BizSOL 金融機関 企業様
API
管理基盤
Anser
BizSOL 金融機関 企業様
第 2章 通信制御
2-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
第2章 通信制御
第 2章 通信制御
2.1-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
2.1 連携手順
2.1.1 企業による API連携概要フロー
(1)事前準備
企業様 API接続システムごとに、クライアント ID(識別子)、パスワード(クライアントパ
スワード)、暗号化キーの管理を実施します。また、事前に企業様ごとに異なる暗号化キー
の払い出しを行い、API連携のリクエストの企業認証識別子を暗号化していただきます。
AnserBizSOLでは正しく企業認証識別子の復号化が出来た事をもって正規の企業様API接続シ
ステムからのアクセスとみなします。
図 2.1-1 接続元システムの特定(直接企業連携)
図 2.1-2 事前準備
凡例: 実線:必須処理 点線:条件付き処理 :画面処理など :メール通知 :その他
API連携接続情報(クライアントパスワード
/リダイレクトURL)を登録 企業管理API連携
接続情報登録・変更画面
企業様API接続
システム 利用者端末 運用端末
クライアントID/暗号化キーの発行を通知
直接企業連携の企業状態を変更
クライアントID/暗号化キーを発行
AnserBizSOL
センタ
直接企業連携の契約付与を依頼
電文項目
(企業認証識別子)
アクセストークン取得や
残高照会などの要求電文
電文項目
(企業認証識別子) 暗号化 復号
企業様API接続システム AnserBizSOL
金融機関様にて運用端末から発行した暗号
化キー(企業様でも変更可能)
Internet
第 2章 通信制御
2.1-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(2)API連携認証~認可完了画面応答
以下に、AnserBizSOLと企業様API接続システム間の連携手順を示します。
図 2.1-3 企業によるAPI連携の概要フロー
各企業の環境から API連携画面の呼び出し
「API連携」ボタン押下
API連携認証
画面
API連携認証
(認可業務選択)画面 「次へ」ボタン押下
「次へ」ボタン押下 API連携認証
(認可期間設定)画面
API連携認証
(情報アクセス認可)画面 「許可」ボタン押下
メール通知(API連携サービス認可)
企業様API接続システム画面へ コールバック
アクセストークン 取得要求電文
アクセストークン 取得応答電文
(アクセストークン+ リフレッシュトークン を発行)
API連携認証
(企業URL入力)画面
API連携認証
(企業認可結果)画面
凡例: 実線:必須処理 点線:条件付き処理 :画面処理など :メール通知
企業側で画面インタフェースを備えていない場
合を想定し、企業API連携接続サービスへリダイレクトを可能とする画面へ遷移する。
企業URLを入力し、 「API連携」ボタン押下
企業API連携接続サービスへ リダイレクト
利用者状態に応じて、ワンタイムパスワード認証やトランザクション認証、追加認証を行う。
照会暗証番号登録が必要な場合、照会暗証番号
の登録を行う。
API管理基盤へリダイレクト
企業API連携接続サービスにおける 認証操作実施
【任意】 企業側サービスでの認証が必要な場合は、 認証を実施する。 認証の要否、認証方法は企業側で検討要
企業様API
接続システム
利用者端末 AnserBizSOL
センタ
API
管理基盤
AnserBizSOLへリダイレクト
企業様API
接続システム
API
管理基盤
第 2章 通信制御
2.2-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
2.2 同時利用制御
2.2.1 パスによる同時利用制御 同一利用者による操作が行われないように制御します。
また、企業様API接続システムからのリクエストが増えることにより金融機関ホストとの通信
が過剰に増えることを防ぐため、同時にAPI連携を利用できる利用者数に金融機関ごとの上限
を設けます。
(1)パスの確保~解放
企業様からの電文要求から応答までの間、1パスが使用中となります。使用中パスは、応答電
文送信後に解放され、他の利用者が使用できます。
なお、各要求電文受信後にエラーとなった場合、異常応答電文送信後にパスを解放します。
表 2.2.1-1 API連携パスの確保/解放契機
項番 確保契機 解放契機 1 残高照会(全口座)要求電文受信時 残高照会(全口座)応答電文送信後
2 残高照会(指定口座)要求電文受信時 残高照会(指定口座)応答電文送信後
3 入出金明細照会(ANSER)要求電文受信時 入出金明細照会(ANSER)応答電文送信後
4 振込入金明細照会(ANSER)要求電文受信時 振込入金明細照会(ANSER)応答電文送信後
5 振込振替依頼データ照会要求電文受信時 振込振替依頼データ照会応答電文送信後
表 2.2.1-2ホスト経路の確保/解放契機
項番 確保契機 解放契機 1 残高照会(全口座)要求電文を受信し、ANSER
電文にて残高照会を行う時
残高照会のANSER電文送信後(取引完了後)
2 残高照会(指定口座)要求電文を受信し、
ANSER電文にて残高照会を行う時
3 入出金明細照会(ANSER)要求電文を受信し、
ANSER電文にて入出金明細照会を行う時
入出金明細照会の ANSER電文送信後(取引
完了後)
4 振込入金明細照会(ANSER)要求電文を受信
し、ANSER電文にて振込入金明細照会を行う
時
振込入金明細照会の ANSER電文送信後(取
引完了後)
5 振込振替依頼データ照会要求電文を受信し、
ANSER電文にて振込振替の一時保存、確定を
行う時
振込振替のANSER電文送信後(取引完了後)
6 API連携認証(照会用暗証番号登録)画面で
「登録」ボタン押下後、ANSER電文を送信する
前
「登録」ボタン押下による次画面遷移時
(2)輻輳時の処理
突発的な利用増加などで同時利用可能な利用者数の上限を超えた場合、輻輳扱いとして企業様
に異常応答電文を送信します。この場合、他の使用中パスが解放された契機により、再度パス
の確保ができます。
第 2章 通信制御
2.3-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
2.3 タイマ管理
企業様とAnserBizSOLの連携時に、お互い正しく通信が行われているかを確認するため、監視
タイマを設けます。
2.3.1 AnserBizSOLでのタイマ監視 API連携時、AnserBizSOL内部または金融機関ホストとの通信時の遅延などを監視するため、
AnserBizSOL側で監視するタイマについては以下のとおりです。
表 2.3.1-1 AnserBizSOLの監視タイマ
項番 タイマ種別 タイマ値 用途 1 API連携ログインパ
スタイマ
455秒 API連携の要求電文を受信してから、応答電文を送信するま
でのログインタイマ。
ログインパスの解放予定を算出するために利用する。
2 API連携タイマ 450秒 API連携の要求電文を受信してから、応答電文を送信するま
でのタイマ。
2.3.2 企業様におけるタイマ監視 API連携時、AnserBizSOLとの通信時の遅延などを監視するため、企業様は以下のタイマを保
持する必要があります。
表 2.3.2-1 企業の監視タイマ
項番 タイマ種別 タイマ値 用途 1 応答電文待ちタイ
マ
任意 通信環境の問題などにより、AnserBizSOLから応答電文が受
信できない場合を想定し、要求電文送信後から応答電文受
信までの監視タイマを設ける。
タイマ値については、企業様が提供するサービス内容に応じ
て考慮する必要がある。
第 3章 利用開始後の手続き
3-1
AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
第3章 利用開始後の手続き
第 3章 利用開始後の手続き
3.1-1
AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
3.1 API連携サービス利用開始後の手続き
3.1.1 API連携サービス利用開始後の手続き API連携サービスのご利用開始後、想定するお手続きのパターンを以下に示します。
(1)トークンの有効期限切れ
OAuth認証による認可手続き時に発行したトークンの有効期限切れの場合、OAuth認証による
再認可手続き(システム間連携の登録)を実施していただく必要があります。
※企業様サーバにて有効期限切れエラー(refresh token has expired.[501])を検知した場
合、再認可が必要な旨のアラームをシステム部(またはIBユーザ部)へ送付するようにアプ
リケーション開発を推奨しています。
(補足)認可時にトークン有効期限を無期限として選択することも可能です。
(2)APIインタフェース追加
ご利用されるAPIインタフェースを追加する場合、OAuth認証による再認可手続き(システム
間連携の登録)後にAPI連携を開始していただく必要があります。
(3)「クライアントパスワード」「暗号化キー」の変更
API連携サービス開始手続きで取得した「クライアントパスワード」「暗号化キー」を変更し
たい場合、企業管理画面より、「クライアントパスワード」「暗号化キー」を変更していただ
く必要があります。その後、設定情報を企業API連携接続システムに再設定してください。
(4)API連携用サーバを更改
API連携用サーバを更改する場合も、ご利用中の「クライアントID」「クライアントパスワー
ド」「暗号化キー」は、そのまま継続してご利用可能です。
企業管理画面より、「リダイレクトURL」の変更を行い、OAuth認証による再認可手続き(シ
ステム間連携の登録)を実施してしていただく必要があります。その後、API連携を開始して
ください。
第 4章 通信シーケンス
4-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
第4章 通信シーケンス
第 4章 通信シーケンス
4.1-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.1 API連携サービスの通信フロー
4.1.1 API連携サービス利用時の基本フロー API連携サービスの利用にあたっての基本的な通信フローを以下に示します。
図 4.1.1-1 API連携サービスの基本フロー
API連携認証による 認証・認可
アクセストークン取得・
再発行
利用者情報照会
<明細照会系業務> 残高照会
入出金明細照会 振込入金明細照会 口座振替結果照会 口座振替手数料照会
<取引照会系業務> 依頼データ照会
<資金移動系業務> 依頼データ登録
アクセストークン取得・
再発行
トークン削除
利用者情報照会電文で取得した契約者通番、口座識別子
(または、企業コード、利用者コード、口座)(※)を使って照
会、依頼データ登録を行う。
利用者の利用可能な口座情報などの最新化のため、ログ
イン時の自動実行を推奨する。
※残高照会、入出金明細照会(ANSER)、振込入金明細照会(ANSER)、振込振替の各業務で使用す
る口座情報については、科目コードが全銀科目であること、口座番号が 1~7桁の可変長であるこ
となどにより、金融機関で管理されている口座情報と一部番号体系が異なる場合があるため、利用
者情報取得電文にて取得した口座情報を使って要求電文の作成を行ってください。
「アクセストークン取得」以降で利用者に
よる操作など、明示的にトークンの削除
が必要な場合、実施する。
企業情報照会
依頼データ登録のために必要と
なる承認者情報の取得を行う。
<トークン削除>
アクセストークン
有効期限切れの場合
アクセストークン取得・
再発行
アクセストークン
有効期限切れの場合
アクセストークン取得・
再発行
アクセストークン
有効期限切れの場合
アクセストークン取得・
再発行
アクセストークン
有効期限切れの場合
<API連携認証による認証・認可~各種照会、依頼データ登録>
事前準備
確定後は承認用のトー
クンにて承認を行う。
第 4章 通信シーケンス
4.1-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
図 4.1.1-2 API連携サービスの基本フロー(承認)
API連携認証による 認証・認可
アクセストークン取得
利用者情報取得
<資金移動系業務> 承認
アクセストークン再発行
アクセストークン
有効期限切れの場合
アクセストークン再発行
アクセストークン
有効期限切れの場合
<API連携認証による認証・認可~承認>
承認用のトークンにて
実施する
第 4章 通信シーケンス
4.2-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2 正常時の通信シーケンス
4.2.1 API連携認証~アクセストークン取得
(1)処理の流れ
API連携認証処理の例として、API連携認証からアクセストークン取得までの処理の流れを図
4.2.1-1に示します。
図 4.2.1-1 API連携認証処理~アクセストークン取得の流れ
企業様
AnserBizSOL
②企業URLへリダイレクト
⑤API連携認証を開始
③認証用URLリダイレクト
⑥AnserBizSOLで利用中の認証を実施
⑭コールバックURLリダイレクト
企業様
⑮アクセストークン取得・再発行要求
⑯アクセストークン取得・再発行応答
※自動遷移
※自動遷移
API連携認証
リフレッシュトークンを同時に発行する。
⑧照会用暗証番号を登録
⑦認可対象業務を選択
API
管理基盤
④AnserBizSOLへリダイレクト
※自動遷移
API連携認証画面
トランザクション
認証画面
ワンタイムパスワード
認証画面
追加認証画面
認可業務選択画面
照会用暗証番号
登録画面
⑨照会用暗証番号登録完了をメール送信
⑩次画面へ遷移
認可期間設定画面
照会用暗証番号
登録結果画面
⑪認可期間を設定
情報アクセス
認可画面
API
管理基盤
認証の必要がある場合のみ遷移
遷移条件はAnserBizSOLログイン時と同様
⑫認可を実施
⑬企業様API接続システムへの認可完了をメール送信
照会用暗証番号が必要な業務が選択されている場合のみ遷移
企業認可結果画面
※自動遷移
企業URL入力画面
①企業様環境から企業URL入力画面の呼び出し
⑰AnserBizSOLへリダイレクト
※自動遷移
第 4章 通信シーケンス
4.2-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(2)処理概要
①利用者は、自企業の環境から「企業URL入力画面」を呼び出す。
②利用者は、「企業 URL入力画面」にて、企業 URLを入力し、企業様 API接続システムへリ
ダイレクトを行う。企業様 API接続システムでのログイン認証などが必要な場合はこのタ
イミングで実施する。
③企業様API接続システムは、AnserBizSOLでの認証を行うため、認証用URLにてAPI管理基
盤へリダイレクトを行う。
④API管理基盤は、リクエスト元に応じてURLを整形し、AnserBizSOLへリダイレクトを行う。
⑤「API連携認証画面」が表示されるので、ログイン ID/パスワードや電子証明書を用いて
ログイン情報を入力し、API連携認証を開始する。
⑥金融機関申込により、認証が必要な場合は、以下の画面に遷移し、認証を行う。
・「トランザクション認証画面」
・「ワンタイムパスワード認証画面」
・「追加認証画面」
⑦「認可業務選択画面」より、認可対象の業務を選択する。
⑧金融機関様申込により、利用者による照会用暗証番号の入力が必要な場合、かつ利用者の
利用可能口座に一つでも照会用暗証番号が未登録の口座が存在する場合、かつ「認可業務
選択画面」にて、照会用暗証番号が必要な業務が選択されている場合、「照会用暗証番号
登録画面」を表示する。利用者は認可する口座に対して、照会用暗証番号を登録する。(※)
⑨AnserBizSOLは、利用者と管理者に対して、照会用暗証番号登録完了をメール送信する。(※)
(詳細は、「付録7.送信メール」参照)
⑩AnserBizSOLは、⑧の操作に対して「照会用暗証番号登録結果画面」を表示する。(※)
⑪「認可期間設定画面」より認可期間を選択する。
⑫「情報アクセス認可画面」にて、利用者は企業様API接続システムへの情報提供を認可する。
⑬AnserBizSOLは、利用者に対して認可完了をメール送信する。(詳細は、「付録7.送信メ
ール」参照)
⑭AnserBizSOLは、企業様API接続システムへリダイレクトを行う。
⑮企業様API接続システムは、API管理基盤を介しAnserBizSOLに対してアクセストークン取
得・再発行要求電文を送信する。
⑯AnserBizSOLは、アクセストークンおよびリフレッシュトークンを発行し、API管理基盤を
介し企業様API接続システムに対してアクセストークン取得・再発行応答電文を送信する。
⑰企業様API接続システムは、AnserBizSOLへリダイレクトを行い「企業認可結果画面」を表
示する。
※一部の金融機関については、口座情報の登録の際の暗証番号に照会用暗証番号ではなく振
込振替暗証番号という別の暗証番号を利用している。そのため、暗証番号の記述について
は適宜読み替えること。
第 4章 通信シーケンス
4.2-3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.2 アクセストークン再発行
(1)処理の流れ
アクセストークン再発行処理の例として、アクセストークン有効期限切れによる再発行を実施
し、情報取得を継続する処理の流れを図 4.2.2-1に示します。
図 4.2.2-1 アクセストークン再発行処理の流れ
(2)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して照会要求電文/登録要求電文を送信す
る。
②AnserBizSOLは、要求電文にて提示されたアクセストークンの有効期限が超過していた場合
に異常応答を、API管理基盤を介し企業様に返却する。
③企業様は、アクセストークンの有効期限切れに伴い、アクセストークン取得・再発行要求
電文を、API管理基盤を介しAnserBizSOLに送信する。
④AnserBizSOLは、アクセストークン取得・再発行要求電文にて提示されたリフレッシュトー
クンを使用し、リフレッシュトークンが有効期限切れでない場合はアクセストークンを再
発行し、アクセストークン取得・再発行応答電文を、API管理基盤を介して企業様に返却す
る。
⑤企業様は、再発行されたアクセストークンを用いて、API管理基盤を介しAnserBizSOLに対
して照会要求電文/登録要求電文のいずれかの要求電文を送信する。
⑥AnserBizSOLは、要求電文に応じて照会応答電文/登録応答電文のいずれかの応答電文を、
API管理基盤を介して企業様へ返却する。
企業様 AnserBizSOL
①XX照会要求/XX登録要求
②異常応答(アクセストークンの有効期限切れ等)
アクセストークン発行で同時に発行したリフレッシュトークンを使用してアクセストークンを再発行する。
アクセストークン再発行
アクセストークンの期限切れを検知したため再発行
③アクセストークン取得・再発行要求
④アクセストークン取得・再発行応答
⑤XX照会要求/XX登録要求
⑥XX照会応答/XX登録応答
API管理基盤
第 4章 通信シーケンス
4.2-4 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.3 基本情報照会
(1)対象電文
・利用者情報照会要求電文/応答電文
・企業情報照会要求電文/応答電文
(2)処理の流れ
API連携による基本情報照会処理の流れを図 4.2.3-1に示します。
図 4.2.3-1 基本情報照会処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して基本情報照会要求電文を送信する。
②AnserBizSOLは、要求に応じた情報を設定して、API管理基盤を介し企業様へ基本情報照会
応答電文を返却する。
企業様 AnserBizSOL
①基本情報照会要求
②基本情報照会応答
AnserBizSOLから指定された情報を返却する
基本情報照会
API管理基盤
第 4章 通信シーケンス
4.2-5 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.4 照会(リアルタイム系)
(1)対象電文
・残高照会(全口座)要求電文/応答電文
・残高照会(指定口座)要求電文/応答電文
・入出金明細照会(ANSER)要求電文/応答電文
・振込入金明細照会(ANSER)要求電文/応答電文
・振込振替依頼データ照会要求電文/応答電文
(2)処理の流れ
API連携による照会(リアルタイム系)処理の流れを図 4.2.4-1に示します。
図 4.2.4-1 照会(リアルタイム系)処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して照会要求電文を送信する。
②AnserBizSOLは、金融機関ホストに対して取引照会指令電文または取引確認指令電文を送信
する。
③金融機関ホストは、照会報告電文にて照会結果を返却する。
④AnserBizSOLは、金融機関ホストに対して確認指令電文を送信する。
⑤金融機関ホストは、FEPセンタに対して確認報告電文を送信する。
⑥AnserBizSOLは、API管理基盤を介し企業様に対して照会応答電文を返却する。
企業様 AnserBizSOL
①照会要求
②取引照会指令
または
取引確認指令
FEP金融機関
ホスト
③取引照会報告
④確認指令
⑤確認報告
⑥照会応答
利用者によるAPI連携先サービ
スのアプリや画面での操作。
または、API連携先サービスの
定期バッチ処理
照会(リアルタイム)
API
管理基盤
第 4章 通信シーケンス
4.2-6 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.5 照会(伝送系)
(1)対象電文
・入出金明細照会(全銀)要求電文/応答電文
・振込入金明細照会(全銀)要求電文/応答電文
・口座振替結果照会要求電文/応答電文
・口座振替手数料照会要求電文/応答電文
・総合振込依頼データ照会要求電文/応答電文
・給与・賞与振込依頼データ照会要求電文/応答電文
・口座振替依頼データ照会要求電文/応答電文
(2)処理の流れ
API連携による照会(伝送系)処理の流れを図 4.2.5-1に示します。
図 4.2.5-1 照会(伝送系)処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して照会要求電文を送信する。
②AnserBizSOLは、API管理基盤を介し企業様に対して口座の明細情報を設定した照会応答電
文を返却する。
企業様 AnserBizSOL
①照会要求
②照会応答
AnserBizSOLに登録されている、口座の明細情報を返却する
照会(伝送系)
API管理基盤
第 4章 通信シーケンス
4.2-7 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.6 依頼データ登録(承認なし)
(1)対象電文
・振込振替依頼データ登録要求/応答(承認なし)
(2)処理の流れ
API連携による依頼データ登録(承認なし)処理の流れを図 4.2.6-1に示します。
図 4.2.6-1依頼データ登録(承認なし)処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して依頼データ登録要求電文を送信する。
②AnserBizSOLは、依頼データの一時保存処理を実施し、API管理基盤を介し企業様に対して
依頼データ登録応答電文を返却する。
③依頼データ作成者は、AnserBizSOLへログインし、保存中取引選択画面より依頼データを選
択する。
④依頼データ作成は、取引金額を入力する。
⑤依頼データ作成者は、依頼データの内容確認を行う。
⑥依頼データ作成者は、依頼データの取引実行を行う。
企業様 AnserBizSOL
①依頼データ登録要求
②依頼データ登録応答
利用者によるAPI連携サービスのアプリや画面での操作。または、API連携サービスの定期バッチ処理
依頼データ登録(承認なし)
③保存中取引から依頼データを選択
④金額を入力
依頼データをAnserBizSOLへ登録(一時保存)
依頼データ作成者がAnserBizSOLへログインし、以降の操作を実施
取引実行(AnserBizSOL)
⑤内容を確認
⑥取引実行
保存中取引選択画面
金額入力画面
内容確認画面
実行確認画面
実行結果画面
API管理基盤
第 4章 通信シーケンス
4.2-8 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.7 依頼データ登録(承認あり)
(1)対象電文
・振込振替依頼データ登録要求/応答(承認あり)
・総合振込依頼データ登録要求/応答
・給与・賞与振込依頼データ登録要求/応答
・口座振替依頼データ登録要求/応答
(2)処理の流れ
API連携による依頼データ登録(承認あり)処理の流れを図 4.2.7-1に示します。
図 4.2.7-1 依頼データ登録(承認あり)処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対して依頼データ登録要求電文を送信する。
②AnserBizSOLは登録処理を実施し、API管理基盤を介し企業様に対して、依頼データ登録応
答電文を返却する。
③AnserBizSOLは、依頼者と承認者へメールを送信する。(詳細は、「付録7.送信メール」
参照)
④承認者は、AnserBizSOLへログインし、承認取引一覧画面より依頼データを選択する。
⑤承認者は、依頼データの内容を確認し、承認実行する。
第 4章 通信シーケンス
4.2-9 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.8 依頼データ承認
(1)対象電文
・振込振替依頼データ承認要求/応答
・総合振込依頼データ承認要求/応答
(2)処理の流れ
API連携による依頼データ承認処理の流れを図 4.2.8-1に示します。
図 4.2.8-1 依頼データ承認処理の流れ
(3)処理概要
①企業様の一次承認者は、API管理基盤を介しAnserBizSOLに対して依頼データ承認要求電文
を送信する。(※)
②AnserBizSOLは一次承認を実施し、API管理基盤を介し企業様に対して、依頼データ承認応
答電文を返却する。(※)
③企業様の最終承認者は、API管理基盤を介しAnserBizSOLに対して依頼データ承認要求電文
を送信する。
④AnserBizSOLは最終承認を実施し、API管理基盤を介し企業様に対して、依頼データ承認応
答電文を返却する。
※シングル承認の場合は一次承認のフローは省略する
API
管理基盤企業様 AnserBizSOL
①依頼データ承認要求
②依頼データ承認応答
AnserBizSOLで、依頼デ
ータの一次承認を行う。
利用者によるAPI連携先
サービスのアプリや画面
での操作
※シングル承認の場合は
一次承認のフローは省略
依頼データ承認
③依頼データ承認要求
④依頼データ承認応答
AnserBizSOLで、依頼データの最終承認を行う。
最終承認
一次承認
第 4章 通信シーケンス
4.2-10 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.2.9 トークン失効
(1)対象電文
・トークン失効要求/応答
(2)処理の流れ
API連携によるトークン失効処理の流れを図 4.2.9-1に示します。
図 4.2.9-1 トークン失効処理の流れ
(3)処理概要
①企業様は、API管理基盤を介しAnserBizSOLに対してトークン失効要求電文を送信する。
②AnserBizSOLはトークン失効を実施し、API管理基盤を介し企業様に対して、トークン失効
応答電文を返却する。
API
管理基盤企業様 AnserBizSOL
①トークン失効要求
②トークン失効応答
AnserBizSOLから、指定さ
れたトークン失効を行う。利用者による口座の連携解除依頼時やログアウト
時など
トークン失効
第 4章 通信シーケンス
4.3-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.3 異常時の通信シーケンス
4.3.1 異常時処理の概要
(1)API連携認証・認可時のエラー
API連携認証中にエラーが発生した場合、AnserBizSOLにて異常終了画面(BSSK902)を表示し
ます。異常終了画面で「遷移元画面に戻る」リンクを押下した際、事前に設定したコールバッ
クURLへ遷移します。その際、遷移先URLのパラメータとしてエラーコード、エラーメッセー
ジを設定します。
(2)依頼データ登録・承認要求電文のエラー、警告
資金移動業務の依頼データ登録・承認要求電文について、AnserBizSOL内でのデータチェック
にて、エラー、警告となった場合は、異常応答電文として、エラー、警告理由を設定して返却
します。
警告のみ場合は、依頼データ登録・承認要求電文に問題ない旨の情報を再設定した電文を送信
することで正常データとして処理を継続することができます。
(3)API連携時、その他要求電文のエラー
API連携時、要求電文受信後にエラーなった場合、通常の応答電文の代わりに異常応答電文を
返却します。
第 4章 通信シーケンス
4.3-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.3.2 API連携認証・認可時のエラー
(1)処理の流れ
API連携認証・認可時のエラー処理の流れを図 4.3.2-1に示します。
図 4.3.2-1 API連携認証・認可時のエラー処理の流れ
(2)処理概要
①利用者は、API連携(企業URL入力)画面にてURLを入力し「連携」ボタンを押下する。
②AnserBizSOLは入力された企業様API連携接続システムのURLへリダイレクトを行う。
③企業様API連携接続システムは、AnserBizSOLでの認証を行うため、API管理基盤側の認証
用の URLへリダイレクトを行う。API管理基盤は金融機関に応じた URLへ変換し、
AnserBizSOLへリダイレクトを行う。
④AnserBizSOLは、企業様API連携接続システムからのリダイレクトによりAPI連携認証画面
を表示する。
⑤利用者は、API連携認証画面にてログイン ID/パスワードや電子証明書を用いてログイン
情報を入力し、「API連携」ボタンを押下して認証を行う。
第 4章 通信シーケンス
4.3-3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
⑥AnserBizSOLにて認証・認可処理中にエラーが発生した場合、異常終了画面を表示する。
⑦利用者は、異常終了画面にて「遷移元画面に戻る」ボタンを押下する。
⑧企業様API接続システムは、AnserBizSOLへリダイレクトを行い「企業認可結果画面」を表
示する。
第 4章 通信シーケンス
4.3-4 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.3.3 依頼データ登録要求時のエラー
(1)処理の流れ
依頼データ登録要求時のエラー時の処理の流れを図 4.3.3-1に示します。
図 4.3.3-1 依頼データ登録要求時のエラー処理の流れ
(2)処理概要
①企業様は、API管理基盤に対して依頼データ登録要求電文を送信する。API管理基盤は、
AnserBizSOLが受信可能な形へデータを整形し、要求電文を送信する。
②AnserBizSOLは、要求電文のデータの内容をチェックし、エラーとなった場合、応答電文に
エラー内容を設定し、API管理基盤に対してを返却する。API管理基盤は、企業様が受信可
能な形へデータを整形し、応答電文を返却する。
※ エラー・警告メッセージを合算して2,001件となった時点で、2,000件までのエラー・警
告内容を返却します。
第 4章 通信シーケンス
4.3-5 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
4.3.4 依頼データ登録要求時の警告
(1)処理の流れ
依頼データ登録要求時の警告処理の流れを図 4.3.4-1に示します。
図 4.3.4-1 依頼データ登録要求時の警告処理の流れ
(2)処理概要
①企業様は、API管理基盤経由でAnserBizSOLに対して依頼データ登録要求電文を送信する。
②AnserBizSOLは、依頼データ登録要求電文のデータ(以下、依頼データ)の内容をチェック
し、警告となった場合、依頼データ登録応答電文に仮取引 ID、警告内容を設定し、API管
理基盤を経由で企業様に対してを返却する。(依頼データは AnserBizSOL内で 180分間保
存)ただし、依頼データ登録要求電文の警告確認区分に「1:実施済」を設定している内容
については、警告応答の対象とせず、登録処理を実施する。(⑥の処理が行われる。)
③企業様は利用者へ警告ありを通知する。
④利用者は、警告ありでの取引登録の実施有無を決める。
⑤企業様は、API管理基盤経由で AnserBizSOLに対して依頼データ登録要求電文を送信する。
再送時の依頼データの設定は、①の時と異なり、仮取引IDと利用者からの実施有無が必要
となり、明細情報などは、AnserBizSOLで保存されているため不要となる。
⑥AnserBizSOLは、依頼内容が取引登録の場合、依頼データの登録処理を実施し、API管理基
盤経由で企業様に対して依頼データ登録応答電文を返却する。
依頼内容が取引キャンセルの場合、依頼データを削除し、企業様に対して依頼データ確定
応答電文を返却する。
以降は、通常の操作と同じ流れとなる。
※ 警告メッセージが2,001件となった時点で、2,000件までの警告内容を返却します。
警告のみであっても、2,001件を超えた時点でエラーとして扱います。
第 5章 通信インタフェース仕様
5-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
第5章 通信インタフェース仕様
第 5章 通信インタフェース仕様
5.1-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.1 API連携サービス用接続先 URL
5.1.1 API連携サービス用接続先 URL 企業様からAnserBizSOLへ通信する際の接続先URLを以下に示します。
表 5.1.1-1 接続先URL(商用環境)
項
番 電文フォーマット URL(※1)
1 企業URL入力画面表示 www.bizsol.anser.ne.jp/9999c/oauth/html_authcode_url
2 認可結果画面取得要求 www.bizsol.anser.ne.jp/9999c/oauth/html_auth_complete
※1 ドメイン部(下線部)について、個別ドメインを利用されている金融機関の場合は、個別ドメインとなる。
表 5.1.1-2 接続先URL(接続試験環境)
項
番 電文フォーマット URL(※1)
1 企業URL入力画面表示 testd.bizsol.anser.ne.jp/9999d/oauth/html_authcode_url
2 認可結果画面取得要求 testd.bizsol.anser.ne.jp/9999d/oauth/html_auth_complete
※1 ドメイン部(下線部)について、個別ドメインを利用されている金融機関の場合は、個別ドメインとなる。
表 5.1.1-3 接続先URL(商用擬似環境)
項
番 電文フォーマット URL(※1)
1 企業URL入力画面表示 testn.bizsol.anser.ne.jp/9999n/oauth/html_authcode_url
2 認可結果画面取得要求 testn.bizsol.anser.ne.jp/9999n/oauth/html_auth_complete
※1 ドメイン部(下線部)について、個別ドメインを利用されている金融機関の場合は、個別ドメインとなる。
5.1.2 上記以外の API連携サービス用接続先 URLについて 上記以外のAPI連携サービス用接続先URLについては、『OpenCanvas API開発者ポータル』(https://portal.opencanvas.ne.jp/api)を確認くだ
さい。
第 5章 通信インタフェース仕様
5.2-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.2 電文フォーマット
5.2.1 企業 URL入力画面表示 企業URL入力画面表示の電文フォーマットを以下に示します。
表 5.2.1-1 企業URL入力画面表示のメッセージ形式
項
番 論理項目名 パラメータ名 設定 繰り 返し 属性 桁数・
文字数 説明
1 リクエストライン
2 メソッド(Method) - 必須
- - - 「GET」を設定する。
3 リクエストURI(Request-URI)
4 BizSOLセンタURL - 必須 - - - AnserBizSOLセンタの URLを設定する(BizSOLセンタ
URL一覧 参照)。
5 サービスレベル slv 任意
※1
- 数字 1 サービスレベルを設定する。
6 表示画面振分用URLパラ
メータ
smart 任意
※1
- 英字 1 以下のとおり設定する。
s:スマートフォン専用画面をブラウザで表示したい場合
b:スマートフォン端末へブラウザ画面を表示したい場合
t:ブラウザ画面(タブレット用)を表示したい場合
7 代表金融機関コード centercode 任意
※1
- 数字 4 JASTEMセンタの金融機関コードを設定する。
※JASTEMでの接続時は必須。
8 金融機関コード bankcode 任意
※1
- 数字 4 県信連/JAの金融機関コードを設定する。
※JASTEMでの接続時は必須。
9 HTTPバージョン
(HTTP-Version)
必須 - - - 利用者端末が使用している HTTPのバージョンを設定
する。
10 リクエストヘッダ
11 ホスト(Host) Host 条件あり (説明欄参照)
- - - HTTPバージョンが “HTTP/1.1” の場合に送信先ホス
ト名、ポート番号を設定する。
※1:任意項目については、設定しない場合はパラメータごと削除する。
第 5章 通信インタフェース仕様
5.2-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.2.2 認可結果画面取得要求 認可結果取得要求の電文フォーマットを以下に示します。
表 5.2.2-1 認可結果取得要求のメッセージ形式
項
番 論理項目名 パラメータ名 設定 繰り 返し 属性 桁数・
文字数 説明
1 リクエストライン
2 メソッド(Method) - 必須
- - - 「GET」を設定する。
3 リクエストURI(Request-URI)
4 BizSOLセンタURL - 必須 - - - AnserBizSOLセンタの URLを設定する(BizSOLセンタ
URL一覧 参照)。
5 クライアント識別子 client_id 必須
- 英数字 8 クライアント識別子を設定する。
6 表示画面振分用URLパラ
メータ
smart 任意
※1
- 英字 1 以下のとおり設定する。
s:スマートフォン専用画面をブラウザで表示したい場合
b:スマートフォン端末へブラウザ画面を表示したい場合
t:ブラウザ画面(タブレット用)を表示したい場合
7 代表金融機関コード centercode 任意
※1
- 数字 4 JASTEMセンタの金融機関コードを設定する。
※JASTEMでの接続時は必須。
8 金融機関コード bankcode 任意
※1
- 数字 4 県信連/JAの金融機関コードを設定する。
※JASTEMでの接続時は必須。
9 発行結果 result 必須
- 数字 1 アクセストークンの発行結果を設定する。
0:成功
1:失敗
10 レスポンスコード response_code 任意
※1
- 数字 3 アクセストークン発行失敗時のレスポンスコードを設定
する。レスポンスコードは「5.3.1 (4)アクセストークン取
得・再発行、トークン失効」のエラーメッセージ内の番号
([XXX])を参照。
※発行結果が「1」(失敗)の時は設定必須。
11 HTTPバージョン
(HTTP-Version)
必須 - - - 利用者端末が使用している HTTPのバージョンを設定
する。
12 リクエストヘッダ
13 ホスト(Host) Host 条件あり (説明欄参照)
- - - HTTPバージョンが “HTTP/1.1” の場合に送信先ホス
ト名、ポート番号を設定する。
※1:任意項目については、設定しない場合はパラメータごと削除する。
第 5章 通信インタフェース仕様
5.2-3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.2.3 上記以外の電文フォーマットについて 上記以外の電文フォーマットについては、『OpenCanvas API開発者ポータル』(https://portal.opencanvas.ne.jp/api)を確認ください。
第 5章 通信インタフェース仕様
5.3-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.3 異常応答電文エラーコード一覧
5.3.1 異常応答電文エラーコード一覧
(1)全インタフェース共通
表 5.3.1-1 異常応答電文エラーコード(全インタフェース共通)(1/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 入力チェックエラー invalid_request invalid parameters requested.
[127]
400 API管理基盤での入力チェックにてエラーがあった場合
2 バージョンチェックエラー access_denied request parameter is invalid.
[126]
400 バージョンチェックでエラーがあった場合。
3 リクエストエラー invalid_request request parameter is invalid.
[130]
400 リクエストエラーを検知した場合。
4 APサーバ障害中エラー
access_denied system was stopped. [203] 400 AnserBizSOLが閉塞中であった場合。
5 BizSOLセンタ運転状態チ
ェックエラー
access_denied service time is over. [204] 400 AnserBizSOLがサービス時間外であった場合。
6 サ ー ビ ス 提 供 状 態
(BizSOLセンタ内障害)チ
ェックエラー
access_denied system was stopped. [205] 400 AnserBizSOLが障害中であった場合。
7 API連携サービス運転状
態チェックエラー
access_denied api service was stopped. [207] 400 API連携サービスが閉塞中の場合。
8 API連携サービス提供有
無チェックエラー
access_denied api service was stopped. [208] 400 API連携サービスを提供していない場合。
9 ログイン可能時間チェック
エラー
access_denied service time is over. [210] 400 ログイン可能時間外の場合。
10 企業契約期間チェックエ
ラー
access_denied service is not in the available
period. [212]
400 契約者の状態が契約期間外の場合。
11 取扱停止中チェックエラ
ー
access_denied service was stopped. [213] 400 契約者の状態が取引停止中の場合。
12 直接企業連携利用可否
チェックエラー
access_denied service was stopped. [278] 400 直接企業連携を行うための企業契約がない場合
第 5章 通信インタフェース仕様
5.3-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-1 異常応答電文エラーコード(全インタフェース共通)(2/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
13 利用者状態チェックエラ
ー
access_denied user status is invalid. [215] 400 以下のような利用者状態の異常を検知した場合。
・利用者未存在
・利用のログインパスワードが停止または一時停止
14 業務利用可否チェックエ
ラー
access_denied api service was stopped. [247] 400 企業様が対象の API連携サービスの業務を利用できない場
合、または対象業務のAPI連携サービスの申込をしていない場
合。
15 システムメンテナンスエラ
ー
access_denied service time is over. [299] 400 システムメンテナンスなど AnserBizSOLが応答不可である場
合。
16 リクエスト過多エラー access_denied request is crowded. [2a0] 400 AnserBizSOLへのリクエストが集中し、処理できない場合。
17 タイムアウトエラー access_denied timeout. [2a1] 400 タイムアウトが発生した場合。
18 その他エラー
server_error internal server error. [601] 500 AnserBizSOLセンタで異常処理を検知した場合。
internal server error. [603]
internal server error. [604]
internal server error. [605]
※1:API連携の応答時
第 5章 通信インタフェース仕様
5.3-3 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(2)API連携認証
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(1/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
1 HTTP改竄エラー invalid_request httpheader is invalid. [102] - 利用者端末が送信した証明書のリクエスト情報に改竄が認め
られた場合。
2 処理 ID妥当性チェックエ
ラー
invalid_request request parameter is invalid.
[109]
- リクエストパラメータの処理IDが不正であった場合。
3 継続サーバ ID妥当性エ
ラー
invalid_request request parameter is invalid.
[110]
- 利用者端末が送信したサーバ IDが、AnserBizSOLで保持して
いるサーバID以外のものであった場合。
4 同一ログインIDの複数ユ
ーザログイン不可チェック
エラー
invalid_request session is invalid. [111] - 同一ログインIDによりログインされ、セッションが削除された場
合。
5 サービス提供状態(金融
機関ホスト障害)チェック
エラー
※4
access_denied service was stopped. [209] 400 金融機関ホストが障害中であった場合。
6 金融機関サービス利用可
能時間チェックエラー
※4
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
7 画面入力項目存在妥当
性エラー
invalid_request request parameter is invalid.
[112]
- 利用者端末が送信したリクエスト内容に想定外のリクエスト項
目が存在した場合。
8 セッション妥当性エラー invalid_request request parameter is invalid.
[113]
- セッションが妥当でない場合。
9 非ログインエラー invalid_request request parameter is invalid.
[114]
- ログインを行っていない状態で、ログイン後の処理へのリクエス
トを受け付けた場合。
10 クライアント識別子最大
登録可能件数超過エラー
※5
access_denied client_id is over. [279] 400 1企業当たりのクライアント識別子最大登録可能件数に到達
し、クライアント識別子を登録できない場合。
11 API連携接続情報登録チ
ェックエラー(未登録)
access_denied api servise connection info is
unregistered. [280]
400 API連携認証電文で受け取ったクライアント識別子のクライアン
トパスワード、リダイレクトURLが未登録の場合。
第 5章 通信インタフェース仕様
5.3-4 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(2/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
14 業務権限チェックエラー
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
15 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
16 ディスパッチエラー invalid_request request parameter is invalid.
[115]
- 利用者端末が送信したリクエスト内容に情報が不足している場
合。
17 画面遷移チェックエラー invalid_request request parameter is invalid.
[116]
- ブラウザの戻るボタンなどの不正な画面遷移を検知した場合。
18 URLパラメータチェックエ
ラー
invalid_request request parameter is invalid.
[117]
- リクエストパラメータ不正を検知した場合。
19 画面改竄チェックエラー invalid_request request parameter is invalid.
[118]
- 画面改竄を検知した場合。
20 外部連携システム障害状
態チェックエラー
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
21 外部連携システム運転状
態チェックエラー
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
22 クライアント識別子存在チ
ェックエラー
invalid_client client id is invalid. [301] - クライアント識別子の不正を検知した場合。
23 コールバック URL正当性
チェックエラー
invalid_request request parameter is invalid.
[119]
400 リクエストパラメータの不正を検知した場合。
24 認証結果チェックエラー
(ログインパスワード一時
停止)
access_denied authentication error. [703] - 認証誤りによりログインパスワード一時停止となった場合。
25 認証結果チェックエラー
(ログインパスワード停
止)
access_denied authentication error. [704] - 認証誤りによりログインパスワード停止となった場合。
26 認証結果チェックエラー
(ログインパスワード一時
停止中)
access_denied authentication error. [705] - ログインパスワードが一時停止中である場合。
27 認証結果チェックエラー
(ログインパスワード停止
中)
access_denied authentication error. [706] - ログインパスワードが停止中である場合。
第 5章 通信インタフェース仕様
5.3-5 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(3/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
28 認証結果チェックエラー
(ログインパスワード停止
(マスターユーザ))
access_denied authentication error. [707] - マスターユーザのログインパスワードが停止中である場合。
29 認証結果チェックエラー
(ログイン ID初期化エラ
ー)
access_denied authentication error. [708] - 該当利用者がログインID初期化中である場合。
30 ログインユーザ方式不正
チェックエラー
access_denied authentication error. [709] - ログインを実行した認証方式と利用者の認証方式が異なる場
合。
31 管理者認証チェックエラ
ー
access_denied authentication error. [710] - 以下のいずれかを満たす場合。
(1)マスターユーザおよび全管理者ユーザのログインパスワー
ドが停止中である場合。
(2)マスターユーザおよび全管理者ユーザの追加認証が利用
停止中である場合。
32 初回ログインユーザチェ
ックエラー
access_denied user is not registered. [217] - 初回ログインが完了していない利用者であった場合。
33 利用者権限チェックエラ
ー(スマートフォン利用不
可)
access_denied user is not authorized to use
smart phone. [218]
400 該当利用者がスマートフォンを利用できない場合。
34 利用者権限チェックエラ
ー(タブレット利用不可)
access_denied user is not authorized to use
tablet. [219]
- 該当利用者がタブレットを利用できない場合。
35 サービスレベルチェックエ
ラー
invalid_request request parameter is invalid.
[120]
- ログイン時のURLパラメータに設定されたサービスレベルと、ロ
グインした企業の画面パターン区分が異なる場合。
36 トランザクション認証状態
チェックエラー(停止中)
access_denied authentication error. [711] 403 トランザクション認証が停止中である場合。
37 OTP認証センタ状態チェ
ックエラー
access_denied authentication error. [712] - ワンタイムパスワード認証センタが停止中である場合。
38 ワンタイムパスワード状
態チェックエラー(未登
録)
access_denied authentication error. [713] - ワンタイムパスワードの利用開始登録が未実施である場合。
第 5章 通信インタフェース仕様
5.3-6 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(4/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
39 ワンタイムパスワード状
態チェックエラー(失効
中)
access_denied authentication error. [714] - ワンタイムパスワードが失効中である場合。
40 ハードウェアトークン有効
期限切れエラー
access_denied authentication error. [715] - ハードウェアトークンが有効期限切れである場合。
41 ワンタイムパスワード状
態チェックエラー(時刻同
期)
access_denied authentication error. [716] - ハードウェアトークンの時刻同期が必要な場合。
42 ワンタイムパスワード認
証状態チェックエラー(停
止中)
access_denied authentication error. [717] - ワンタイムパスワードが利用停止中である場合。
43 メール通知パスワード停
止状態チェックエラー
access_denied email notification password was
blocked. [220]
- メール通知パスワードが通知停止中である場合。
44 IBロックチェックエラー
access_denied service was locked. [221] 400 IBロック中である場合。
45 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
46 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 同一利用者に対する API連携操作実行中のため、ログインパ
スを取得できない場合。
47 不正リスク評価取消判定
チェックエラー
access_denied authentication error. [719] - リスクベース認証によるリスク判定の結果、アクセス不可と判断
された利用者である場合。
48 追加認証結果チェックエ
ラー(追加認証一時停止)
access_denied authentication error. [720] - 追加認証が一時停止となった場合。
49 追加認証結果チェックエ
ラー(追加認証停止)
access_denied authentication error. [721] - 追加認証が利用停止となった場合。
50 認証結果チェックエラー
(追加認証一時停止中)
access_denied authentication error. [722] - 追加認証が一時停止中である場合。
第 5章 通信インタフェース仕様
5.3-7 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(5/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
51 認証結果チェックエラー
(追加認証停止中)
access_denied authentication error. [723] - 追加認証が利用停止中である場合。
52 追加認証回答登録チェッ
クエラー
access_denied authentication error. [724] - 追加認証に必要な秘密の質問の回答が登録されていない場
合。
53 ログインパスワード期限
切れチェックエラー
access_denied password has expired. [224] - ログインパスワードが期限切れである場合。
54 ログインパスワード強制
変更チェックエラー
access_denied password has expired. [225] - ログインパスワードの強制変更が必要な場合。
55 メール通知パスワード一
時通知停止状態チェック
エラー
access_denied email notification password was
blocked. [226]
- 操作者のメール通知パスワードが一時通知停止状態であり、メ
ールアドレスの変更が必要である場合。
56 メールアドレス稼働状態
チェックエラー
access_denied email address is invalid. [227] - 操作者のメールアドレスが停止中(現在の E-mailが無効)であ
る場合。
57 トランザクション認証登録
状態チェックエラー(未登
録)
access_denied authentication error. [725] - トランザクション認証の利用開始登録が未実施、または失効中
である場合。
58 トランザクション認証登録
状態チェックエラー(仮登
録)
access_denied authentication error. [726] - トランザクション認証の利用開始登録中である場合。
59 利用可能口座存在チェッ
クエラー
not_found user does not have available
account. [228]
404 利用可能口座がない場合。
60 証明書認証結果チェック
エラー
invalid_request request parameter is invalid.
[121]
- リクエストパラメータ不正を検知した場合。
61 証明書失効中チェックエ
ラー(失効済み)
access_denied authentication error. [727] - クライアント証明書が失効中である場合。
62 証明書更新チェックエラ
ー
access_denied authentication error. [728] - クライアント証明書の更新が必要な場合。
第 5章 通信インタフェース仕様
5.3-8 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(6/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
63 ブラウザワンタイムパス
ワード認証利用可否/利
用トークン変更チェックエ
ラー
access_denied authentication error. [729] - 以下のいずれかを満たす場合。
(1)ブラウザワンタイムパスワードを「利用しない」に変更された
場合。
(2)API連携認証時、利用者が使用するトークンがソフトウェア
トークンからハードウェアトークンに変更された場合。
(3)API連携認証時、利用者が使用するトークンがハードウェア
トークンからソフトウェアトークンに変更された場合。
64 ソフトウェアトークン有効
期限切れエラー
access_denied authentication error. [730] - ソフトウェアトークンが有効期限切れである場合。
65 トークンロック解除応答結
果チェックエラー(トークン
ロック解除調整中エラー)
access_denied authentication error. [731] - ワンタイムパスワードトークンのロック解除時に異常が発生した
場合。
66 認証結果チェックエラー
(ワンタイムパスワードト
ークンロック)
access_denied authentication error. [732] - ワンタイムパスワードトークンがロック中である場合。
67 認証結果チェックエラー
(ワンタイムパスワード該
当利用者無し)
access_denied authentication error. [733] - 以下のいずれかを満たす場合。
(1)利用者のワンタイムパスワードトークンが未発行
(2)利用者が解約済み
68 認証結果チェックエラー
(ワンタイムパスワードメ
ール送信済み当該利用
者有り)
access_denied authentication error. [734] - ソフトウェアトークンの設定が未完了である場合。
69 認証結果チェックエラー
(利用停止該当利用者有
り)
access_denied authentication error. [735] - 利用者のワンタイムパスワードが失効中である場合。
70 認証結果チェックエラー
(OTP認証調整中エラー)
access_denied authentication error. [736] - ワンタイムパスワードによる認証時に異常が発生した場合。
71 認証結果チェックエラー
(トランザクション認証トー
クンロック)
access_denied authentication error. [737] - トランザクション認証用トークンがロック中である場合。
第 5章 通信インタフェース仕様
5.3-9 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-2 異常応答電文エラーコード(API連携認証)(7/7)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況(※2、※3)
72 その他エラー(認証) access_denied authentication error. [738] - その他認証誤りが発生した場合。
ワンタイムパスワード認証、証明書認証、トランザクション認証
などの認証処理でエラーとなった場合は一律このエラーを返却
する。
※通信異常なども含む
73 二重ログインエラー
access_denied request is crowded. [229] - 二重ログインエラーである場合。
74 中止(拒否) access_denied authorization processing was
stopped by user. [739]
- API連携認証が中止された場合。
75 CLAパス輻輳 ※4
access_denied request is crowded. [234] 400 ホスト経路数の輻輳が発生した場合。
76 認証時間経過チェックエ
ラー※5
access_denied response synchronous count is
over. [251]
400 SMBCホストとの通信で規定時間内に通信が完了しない場合。
※1:API連携の応答時
※2:異常発生時は、コールバックURLのパラメータにエラーコード、エラーメッセージを設定して返却する(その場合、HTTPステータスコードは"302"を設定する)。
※3:API連携認証~リダイレクト(コールバック)までの画面遷移中でのエラー
※4:照会用暗証番号(または振込振替暗証番号)の登録時のみ
※5:SMBCの場合のみ発生
第 5章 通信インタフェース仕様
5.3-10 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(3)認可結果画面取得
表 5.3.1-3 異常応答電文エラーコード(認可結果画面取得)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 HTTP改竄エラー invalid_request httpheader is invalid. [102] - 利用者端末が送信した証明書のリクエスト情報に改竄が認め
られた場合。
2 処理 ID妥当性チェックエ
ラー
invalid_request request parameter is invalid.
[109]
- リクエストパラメータの処理IDが不正であった場合。
3 継続サーバID妥当性エラ
ー
invalid_request request parameter is invalid.
[110]
- 利用者端末が送信したサーバ IDが、AnserBizSOLで保持して
いるサーバID以外のものであった場合。
4 セッション妥当性エラー invalid_request request parameter is invalid.
[113]
- セッションが妥当でない場合。
5 クライアント識別子存在チ
ェックエラー
invalid_client client id is invalid. [301] - クライアント識別子の不正を検知した場合。
第 5章 通信インタフェース仕様
5.3-11 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(4)アクセストークン取得・再発行、トークン失効
表 5.3.1-4 異常応答電文エラーコード(アクセストークン取得・再発行、トークン失効)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid. [103] 400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid. [104] 400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 共同センタ妥当性エラー
※2
invalid_request request parameter is invalid. [106] 400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
4 利用可能期間チェックエ
ラー(JASTEM)※2
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
5 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
6 コールバック URL正当性
チェックエラー
invalid_request request parameter is invalid. [119] 400 リクエストパラメータ不正を検知した場合。
7 クライアント識別子認証エ
ラー
invalid_client authentication error. [740] 401 クライアント識別子認証が失敗した場合。
8 認可コード期限切れエラ
ー※3
invalid_grant approval code has expired. [401] 400 認可コードが有効期限切れである場合。
9 認可コード誤り invalid_grant approval code is invalid. [402] 400 不正な認可コードによるアクセスである場合。
10 不正リクエスト invalid_request request parameter is invalid. [123] 400 不正なリクエストパラメータである場合。
11 リフレッシュトークン期限
切れエラー
invalid_grant refresh token has expired. [501] 400 リフレッシュトークンが有効期限切れである場合。
12 リフレッシュトークン誤り
※3
invalid_grant refresh token is invalid. [502] 400 不正なリフレッシュトークンによるアクセスである場合。
13 アクセストークントークン
誤り※3
invalid_grant access token is invalid. [503] 400 不正なアクセストークンによるアクセスである場合。
14 アクセストークントークン
誤り(トークン失効時)※4
invalid_token access token is invalid. [503] 200 不正なアクセストークンによるアクセスである場合。
15 JSONパーサエラー invalid_request request parameter is invalid. [125] 400 JSONパーサエラーが発生した場合。
※1:API連携の応答時
※2:JAバンク(JASTEM)の場合のみ発生
※3:アクセストークン取得・再発行時の場合のみ発生
※4:トークン失効時の場合のみ発生
第 5章 通信インタフェース仕様
5.3-12 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(5)企業情報照会、利用者情報照会
表 5.3.1-5 異常応答電文エラーコード(企業情報照会、利用者情報照会)(1/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 共同センタ妥当性エラー
※5
invalid_request request parameter is invalid.
[106]
400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
4 利用可能期間チェックエ
ラー(JASTEM)※5
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
5 金融機関サービス利用可
能時間チェックエラー
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
6 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
7 業務権限チェックエラー
※2
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
8 利用者権限チェックエラ
ー※3
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
9 外部連携システム障害状
態チェックエラー※3
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
10 外部連携システム運転状
態チェックエラー※3
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
11 その他エラー(APIGW)
※3
server_error internal server error. [602] 500 金融機関ホストで異常処理検知した場合。
12 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
13 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 同一利用者に対する API連携操作実行中のため、ログインパ
スを取得できない場合。
14 利用可能口座存在チェッ
クエラー※2 ※3
not_found user does not have available
account. [228]
404 利用可能口座がない場合。
第 5章 通信インタフェース仕様
5.3-13 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-5 異常応答電文エラーコード(企業情報照会、利用者情報照会)(2/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
15 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
16 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 401 不正なアクセストークンによるアクセスである場合。
17 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 401 アクセストークンの有効期限が切れている場合。
18 API連携パス輻輳※3
access_denied request is crowded. [233] 400 API連携パスの輻輳が発生した場合。
19 サービス取得時間超過
※3 ※4
invalid_request session timeout. [124] 400 利用者情報取得時に、API連携タイマのタイムアウトが発生し
た場合。
20 認証情報変更エラー※3
access_denied authentication error. [741] 400 SMBCホストで管理する認証情報に変更があった場合。
21 最大明細件数超過エラー
※3 ※4
access_denied detailinfo count is over. [252] 400 最大明細件数を超える情報を受信した場合。
22 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
23 セキュリティ設定チェック
エラー※3 ※4
access_denied security setting error. [267] 400 SMBCホストでのセキュリティ設定でエラーとなった場合。
24 お試し期間超過エラー
※3
access_denied trial period is over. [281] 400 無料期間が終了していて、継続申込されていない場合
25 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
26 OTP認証利用不可エラー
※3
access_denied otp auth is required. [202] 400 ワンタイムパスワード認証が必要な場合。
27 二経路認証利用無エラー
※3
access_denied two way auth is required. [206] 400 二経路認証が必須の場合。
※1:API連携の応答時
※2:企業情報照会時のみ発生
※3:SMBCの場合のみ発生
※4:利用者情報照会時の場合のみ発生
※5: JAバンク(JASTEM)の場合のみ発生
第 5章 通信インタフェース仕様
5.3-14 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(6)残高照会、入出金明細照会、振込入金明細照会
表 5.3.1-6 異常応答電文エラーコード(残高照会、入出金明細照会、振込入金明細照会)(1/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 共同センタ妥当性エラー
※12
invalid_request request parameter is invalid.
[106]
400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
4 利用可能期間チェックエ
ラー(JASTEM)※12
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
5 サービス提供状態(金融
機関ホスト障害)チェック
エラー
access_denied service was stopped. [209] 400 金融機関ホストが障害中であった場合。
6 金融機関サービス利用可
能時間チェックエラー
※11
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
7 企業認証識別子認証エラ
ー※11
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
8 業務権限チェックエラー
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
9 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
10 外部連携システム障害状
態チェックエラー※2 ※8
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
11 外部連携システム運転状
態チェックエラー※2 ※8
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
12 その他エラー(APIGW)
※2 ※8
server_error internal server error. [602] 500 金融機関ホストで異常処理検知した場合。
第 5章 通信インタフェース仕様
5.3-15 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-6 異常応答電文エラーコード(残高照会、入出金明細照会、振込入金明細照会)(2/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
13 パス確保可否チェックエ
ラー※11
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
14 パス確保可否チェックエ
ラー(API連携操作中)
※11
access_denied request is crowded. [223] 400 API連携認証時にログインパスまたはホスト経路数で輻輳が発
生した場合。
15 利用可能口座存在チェッ
クエラー※2 ※8 ※11
not_found user does not have available
account. [228]
404 利用可能口座がない場合。
16 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
17 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 401 不正なアクセストークンによるアクセスである場合。
18 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 401 アクセストークンの有効期限が切れている場合。
19 照会対象口座チェックエ
ラー※11
not_found account is unavailable. [230] 404 指定された口座が利用可能な口座ではない場合。
・利用者の利用可能口座ではない
・科目が対象の業務では使用できない
・口座のサービス状態が“利用可能”ではない
20 利用中口座チェックエラ
ー※11
access_denied account is used by another user.
[231]
400 指定された口座が他の利用者により使用中である場合。
21 照会用暗証番号未登録
(振込振替暗証番号未登
録)※3
access_denied password is unregistered. [232] 400 指定された口座の照会用暗証番号(または振込振替暗証番
号)が未登録である場合。
22 API連携パス輻輳
※11
access_denied request is crowded. [233] 400 API連携パスの輻輳が発生した場合。
23 CLAパス輻輳
※3 ※11
access_denied request is crowded. [234] 400 ホスト経路数の輻輳が発生した場合。
24 CLA_サービス時間外拒
否報告※3 ※11
access_denied service time is over. [235] 400 CLAより以下の電文が返却された場合。
・サービス時間外拒否報告
25 CLA_輻輳拒否報告
※3 ※11
access_denied access is congestion. [236] 400 CLAより以下の電文が返却された場合。
・輻輳拒否報告
・回線輻輳
第 5章 通信インタフェース仕様
5.3-16 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-6 異常応答電文エラーコード(残高照会、入出金明細照会、振込入金明細照会)(3/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
26 CLA_暗証番号誤り報告
(誤り規定回数内)※3
access_denied password is invalid. [237] 400 CLAより以下の電文が返却された場合。
・暗証番号誤り報告(誤り規定回数内)
・暗証番号チェックエラー
(利用者による照会用暗証番号(または振込振替暗証番号)を
入力する場合のみ。それ以外は、その他のエラーとする。)
27 CLA_暗証番号誤り報告
(誤り規定回数オーバ)
※3
access_denied password was blocked. [238] 400 CLAより以下の電文が返却された場合。
・暗証番号誤り報告(誤り規定回数オーバ)
(利用者による照会用暗証番号(または振込振替暗証番号)を
入力する場合のみ。それ以外は、その他のエラーとする。)
28 その他ホスト接続に関す
るエラー※3
access_denied service unavailable. [239] 400 その他CLAからのエラーが返却された場合。
29 有効日付チェックエラー
※4 ※5
access_denied request date is invalid. [240] 400 暦上に存在しない日付が設定されている場合。
30 From≦To大小比較エラ
ー※5
access_denied start date is later than end date.
[241]
400 取得開始日が終了日を上回る場合。
31 照会可能期間以降チェッ
クエラー※5
access_denied You can try from 【処理可能な
範囲を返却する】 days ago.
[242]
400 要求された明細取得範囲が照会可能期間を超える場合。
32 当日以内チェックエラー
※4 ※5
access_denied the future date is set. [243] 400 未来日を設定された場合。
33 サービス取得時間超過
※6
invalid_request session timeout. [124] 400 入出金明細照会、振込入金明細照会時に、API連携タイマのタ
イムアウトが発生した場合。
34 照会可能期間範囲外エラ
ー※2 ※8
access_denied request date is out of range.
[246]
400 要求された明細取得範囲が照会可能期間を超える場合。
35 認証情報変更エラー
※2 ※8
access_denied authentication error. [741] 400 SMBCホストで管理する認証情報に変更があった場合。
36 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
37 金額表示上限超過エラー
※2 ※7
access_denied amount of money is over. [265] 400 照会応答時に金額表示桁数を超える照会条件を指定された場
合。
38 金融機関ホスト輻輳拒否
報告※2 ※8
access_denied access is congestion. [266] 400 金融機関ホストの受付が混雑している場合。
第 5章 通信インタフェース仕様
5.3-17 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-6 異常応答電文エラーコード(残高照会、入出金明細照会、振込入金明細照会)(4/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
39 セキュリティ設定チェック
エラー※2 ※8
access_denied security setting error. [267] 400 SMBCホストでのセキュリティ設定でエラーとなった場合。
40 お試し期間超過エラー
※2 ※8
access_denied trial period is over. [281] 400 無料期間が終了していて、継続申込されていない場合
41 日付誤り報告※9 access_denied date is invalid. [272] 400 CLAより以下の電文を受信した場合。
・日付誤り報告
42 明細件数オーバ拒否報告
※10
access_denied reject detail_count over. [275] 400 CLAより以下の電文を受信した場合。
・明細件数オーバ拒否報告
43 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
44 OTP認証利用不可エラー
※2
access_denied otp auth is required. [202] 400 ワンタイムパスワード認証が必要な場合。
45 二経路認証利用無エラー
※2
access_denied two way auth is required. [206] 400 二経路認証が必須の場合。
※1:API連携の応答時
※2:SMBCの場合のみ発生
※3:残高照会、入出金明細照会(ANSER)、振込入金明細照会(ANSER)の場合に発生
※4:SMBCの残高照会の場合に発生
※5:入出金明細照会(ANSER)、入出金明細照会(全銀)、振込入金明細照会(全銀)の場合に発生
※6:入出金明細照会(ANSER)、入出金明細照会(全銀)、振込入金明細照会(ANSER)、振込入金明細照会(全銀)の場合に発生
※7:入出金明細照会(全銀)、振込入金明細照会(全銀)の場合に発生
※8:残高照会、入出金明細照会(全銀)、振込入金明細照会(全銀)の場合に発生
※9:入出金明細照会(ANSER)の場合に発生
※10:入出金明細照会(ANSER)、振込入金明細照会(ANSER)の場合に発生
※11:残高照会(全口座)でのみエラーとならない。別途エラーコード、エラーメッセージを正常応答で返却する。
※12: JAバンク(JASTEM)の場合のみ発生
第 5章 通信インタフェース仕様
5.3-18 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(7)口座振替結果照会、口座振替手数料照会
表 5.3.1-7 異常応答電文エラーコード(口座振替結果照会、口座振替手数料照会)(1/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 共同センタ妥当性エラー
※2
invalid_request request parameter is invalid.
[106]
400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
4 利用可能期間チェックエ
ラー(JASTEM)※2
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
5 金融機関サービス利用可
能時間チェックエラー
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
6 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
7 業務権限チェックエラー
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
8 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
9 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
10 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 API連携認証時にログインパスまたはホスト経路数で輻輳が発
生した場合。
11 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
12 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 403 不正なアクセストークンによるアクセスである場合。
13 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 400 アクセストークンの有効期限が切れている場合。
14 照会対象口座チェックエ
ラー
not_found account is unavailable. [230] 404 指定された口座が利用可能な口座ではない場合。
・利用者の利用可能口座ではない
・科目が対象の業務では使用できない
・口座のサービス状態が“利用可能”ではない
第 5章 通信インタフェース仕様
5.3-19 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-7 異常応答電文エラーコード(口座振替結果照会、口座振替手数料照会)(2/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
16 有効日付チェックエラー
※1
access_denied request date is invalid. [240] 400 暦上に存在しない日付が設定されている場合。
17 当日以内チェックエラー
※1
access_denied the future date is set. [243] 400 未来日を設定された場合。
18 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
19 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
※1:口座振替結果照会の場合に発生
※2:JAバンク(JASTEM)の場合のみ発生
第 5章 通信インタフェース仕様
5.3-20 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(8)振込振替(依頼データ登録、依頼データ照会)
表 5.3.1-8 異常応答電文エラーコード(振込振替(依頼データ登録、依頼データ照会))(1/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 サービス提供状態(金融
機関ホスト障害)チェック
エラー※4
access_denied service was stopped. [209] 400 金融機関ホストが障害中であった場合。
2 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
3 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
4 共同センタ妥当性エラー
※5
invalid_request request parameter is invalid.
[106]
400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
5 利用可能期間チェックエ
ラー(JASTEM)※5
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
6 金融機関サービス利用可
能時間チェックエラー
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
7 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
8 業務権限チェックエラー
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
9 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
10 外部連携システム障害状
態チェックエラー※2
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
11 外部連携システム運転状
態チェックエラー※2
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
12 その他エラー(APIGW)
※2 ※3
server_error internal server error. [602] 500 金融機関ホストで異常処理検知した場合。
13 利用者権限チェックエラ
ー(スマートフォン利用不
可)※3
access_denied user is not authorized to use
smart phone. [218]
400 該当利用者がスマートフォンを利用できない場合。
第 5章 通信インタフェース仕様
5.3-21 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-8 異常応答電文エラーコード(振込振替(依頼データ登録、依頼データ照会))(2/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
14 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
15 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 API連携認証時にログインパスまたはホスト経路数で輻輳が発
生した場合。
16 利用可能口座存在チェッ
クエラー※3
not_found user does not have available
account. [228]
404 利用可能口座がない場合。
17 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
18 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 401 不正なアクセストークンによるアクセスである場合。
19 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 401 アクセストークンの有効期限が切れている場合。
20 照会対象口座チェックエ
ラー※4
not_found account is unavailable. [230] 404 指定された口座が利用可能な口座ではない場合。
・利用者の利用可能口座ではない
・科目が対象の業務では使用できない
・口座のサービス状態が“利用可能”ではない
21 利用中口座チェックエラ
ー
access_denied account is used by another user.
[231]
400 指定された口座が他の利用者により使用中である場合。
22 照会用暗証番号未登録
(振込振替暗証番号未登
録)※4
access_denied password is unregistered. [232] 400 指定された口座の照会用暗証番号(または振込振替暗証番
号)が未登録である場合。
23 API連携パス輻輳
※2
access_denied request is crowded. [233] 400 API連携パスの輻輳が発生した場合。
24 CLAパス輻輳※4
access_denied request is crowded. [234] 400 ホスト経路数の輻輳が発生した場合。
25 CLA_サービス時間外拒
否報告※4
access_denied service time is over. [235] 400 CLAより以下の電文が返却された場合。
・サービス時間外拒否報告
26 CLA_輻輳拒否報告※4 access_denied access is congestion. [236] 400 CLAより以下の電文が返却された場合。
・輻輳拒否報告
・回線輻輳
第 5章 通信インタフェース仕様
5.3-22 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-8 異常応答電文エラーコード(振込振替(依頼データ登録、依頼データ照会))(3/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
27 CLA_暗証番号誤り報告
(誤り規定回数内)※4
access_denied password is invalid. [237] 400 CLAより以下の電文が返却された場合。
・暗証番号誤り報告(誤り規定回数内)
・暗証番号チェックエラー
(利用者による照会用暗証番号(または振込振替暗証番号)を
入力する場合のみ。それ以外は、その他のエラーとする。)
28 CLA_暗証番号誤り報告
(誤り規定回数オーバ)
※4
access_denied password was blocked. [238] 400 CLAより以下の電文が返却された場合。
・暗証番号誤り報告(誤り規定回数オーバ)
(利用者による照会用暗証番号(または振込振替暗証番号)を
入力する場合のみ。それ以外は、その他のエラーとする。)
29 その他ホスト接続に関す
るエラー※4
access_denied service unavailable. [239] 400 その他CLAからのエラーが返却された場合。
30 照会可能期間範囲外エラ
ー※2 ※4
access_denied request date is out of range.
[246]
400 要求された明細取得範囲が照会可能期間を超える場合。
31 認証情報変更エラー
※2
access_denied authentication error. [741] 400 SMBCホストで管理する認証情報に変更があった場合。
32 指定日未存在エラー※3 access_denied transfer date is not exist. [254] 400 利用者権限と操作タイミングにより指定可能な振込指定日が無
い場合。
33 仕掛中取引件数超過エラ
ー※3
access_denied dealing count is over. [255] 400 仕掛中取引件数の最大件数を超過した場合。
34 承認パターン区分不一致
エラー
access_denied approval pattern is not exist.
[256]
400 要求電文で指定された承認パターン区分とシステム上の承認
パターン区分が一致していない場合。
35 保存中取引件数チェック
エラー※3
access_denied savelinfo count is over. [257] 400 利用者が保存できる取引件数を超過した場合。
36 利用者権限チェックエラ
ー(仮登録期間中保有権
限)※3
access_denied user is not authorized. [261] 400 トランザクション認証、またはワンタイムパスワード認証が仮登
録期間内で、都度当日取引を行うための利用者権限がない場
合。
37 一時保存機能提供なしエ
ラー※3
access_denied save function is none. [262] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
38 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
39 承認者存在チェックエラ
ー※3
access_denied authorizer is not exist. [264] 400 確定可能な承認者が存在しない場合。
第 5章 通信インタフェース仕様
5.3-23 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-8 異常応答電文エラーコード(振込振替(依頼データ登録、依頼データ照会))(4/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
40 金融機関ホスト輻輳拒否
報告※2 ※4
access_denied access is congestion. [266] 400 金融機関ホストの受付が混雑している場合。
41 お試し期間超過エラー
※2
access_denied trial period is over. [281] 400 無料期間が終了していて、継続申込されていない場合
42 照会可能期間チェックエ
ラー※4
access_denied inquiry date over. [270] 400 取引データの照会可能期間を超過している場合。
43 受付番号拒否報告※4 access_denied reject receipt_number. [273] 400 CLAより以下の電文を受信した場合。
・受付番号拒否報告
44 受付番号誤り報告※4 access_denied receipt_number is invalid. [274] 400 CLAより以下の電文を受信した場合。
・受付番号誤り報告
45 明細件数オーバ拒否報告
※4
access_denied reject detail_count over. [275] 400 CLAより以下の電文を受信した場合。
・明細件数オーバ拒否報告
46 受付番号重複エラー※4 access_denied receipt_number is overlapping.
[278]
400 受付番号が重複している場合。
47 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
48 取引データチェックエラー
※2 ※4
access_denied transaction data is invalid. [286] 400 当該取引をAPI連携で操作できない場合。
49 残高不足エラー(APIGW)
※2 ※4
access_denied balance is insufficient. [297] 400 残高が不足しているため、振込/振替ができない場合。
50 マル優限度額オーバエラ
ー(APIGW) ※2 ※4
access_denied tax exemption limits over. [298] 400 マル優限度額を超えているため、振込/振替ができない場合。
51 OTP認証利用不可エラー
※2
access_denied otp auth is required. [202] 400 ワンタイムパスワード認証が必要な場合。
52 二経路認証利用無エラー
※2
access_denied two way auth is required. [206] 400 二経路認証が必須の場合。
※1:API連携の応答時
※2:SMBCの場合のみ発生
※3:振込振替依頼データ登録の場合に発生
※4:振込振替依頼データ照会の場合に発生
※5: JAバンク(JASTEM)の場合のみ発生
第 5章 通信インタフェース仕様
5.3-24 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(9)総合振込、給与・賞与振込、口座振替(依頼データ登録、依頼データ照会)
表 5.3.1-9 異常応答電文エラーコード(総合振込、給与・賞与振込、口座振替(依頼データ登録、依頼データ照会))(1/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 共同センタ妥当性エラー
※9
invalid_request request parameter is invalid.
[106]
400 共同センタでの代表金融機関コードと個別金融機関コードの組
合せが妥当でない場合。
4 利用可能期間チェックエ
ラー(JASTEM)※9
access_denied specified bank is not in the
available period. [201]
400 共同センタの個別金融機関が利用可能期間内でない場合。
5 金融機関サービス利用可
能時間チェックエラー
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
6 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合
7 業務権限チェックエラー
access_denied service was stopped. [214] 400 API連携を行うための業務権限がない場合。
8 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
9 外部連携システム障害状
態チェックエラー
※2 ※3 ※4 ※6
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
10 外部連携システム運転状
態チェックエラー
※2 ※3 ※4 ※6
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
11 その他エラー(APIGW)
※2 ※3 ※4 ※6
server_error internal server error. [602] 500 金融機関ホストで異常処理検知した場合。
12 トランザクション認証状態
チェックエラー(停止中)
※3 ※4
access_denied authentication error. [711] 403 利用者のトランザクション認証の利用状態が停止中の場合。
第 5章 通信インタフェース仕様
5.3-25 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-9 異常応答電文エラーコード(総合振込、給与・賞与振込、口座振替(依頼データ登録、依頼データ照会))(2/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
13 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
14 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 API連携認証時にログインパスまたはホスト経路数で輻輳が発
生した場合。
15 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
16 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 401 不正なアクセストークンによるアクセスである場合。
17 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 401 アクセストークンの有効期限が切れている場合。
18 照会対象口座チェックエ
ラー※6 ※7 ※8
not_found account is unavailable. [230] 404 指定された口座が利用可能な口座ではない場合。
・利用者の利用可能口座ではない
・科目が対象の業務では使用できない
・口座のサービス状態が“利用可能”ではない
19 API連携パス輻輳
※2 ※3 ※4 ※6
access_denied request is crowded. [233] 400 API連携パスの輻輳が発生した場合。
20 サービス取得時間超過
※2 ※3 ※4 ※6
invalid_request session timeout. [124] 400 依頼データ登録、依頼データ照会時に、API連携タイマのタイム
アウトが発生した場合。
21 認証情報変更エラー
※2 ※3 ※4 ※6
access_denied authentication error. [741] 400 SMBCホストで管理する認証情報に変更があった場合。
22 仕掛中取引件数超過エラ
ー※3 ※4 ※5
access_denied dealing count is over. [255] 400 仕掛中取引件数の最大件数を超過した場合。
23 承認パターン区分不一致
エラー
※3 ※4 ※5
access_denied approval pattern is not exist.
[256]
400 要求電文で指定された承認パターン区分とシステム上の承認
パターン区分が一致していない場合。
24 取引状態チェックエラー
※6 ※7 ※8
access_denied transaction status is invalid.
[258]
400 取引状態が保存中である場合。
第 5章 通信インタフェース仕様
5.3-26 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-9 異常応答電文エラーコード(総合振込、給与・賞与振込、口座振替(依頼データ登録、依頼データ照会))(3/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
25 口座/委託者データ存在
チェックエラー
※3 ※4 ※5
access_denied account payer is not exist. [259] 400 口座/委託者データが存在しない場合。
26 手数料情報取得エラー
※3
access_denied transfer fee is unavailable. [260] 400 手数料体系情報が取得できなかった場合。
27 トランザクション認証状態
チェックエラー(仮登録期
間外)※3 ※4
access_denied authentication error. [742] 403 仮登録期間を過ぎても、トランザクション認証を利用開始してい
ない場合。
28 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
29 承認者存在チェックエラ
ー※3 ※4 ※5
access_denied authorizer is not exist. [264] 400 確定可能な承認者が存在しない場合。
30 セキュリティ設定チェック
エラー※2 ※6
access_denied security setting error. [267] 400 SMBCホストでのセキュリティ設定でエラーとなった場合。
31 お試し期間超過エラー
※2 ※3 ※4 ※6
access_denied trial period is over. [281] 400 無料期間が終了していて、継続申込されていない場合
32 仮取引データ確定可能時
間超過エラー
※3 ※4 ※5
access_denied confirm time is over. [269] 400 依頼データ警告エラー時の確定再要求時において仮取引デー
タ確定可能時間を超過している場合。
33 照会可能期間チェックエ
ラー※6 ※7 ※8
access_denied inquiry date over. [270] 400 取引データの照会可能期間を超過している場合。
34 仮取引データ取得エラー
取引データ取得エラー
※3 ※4 ※5 ※10
access_denied transaction info is unavailable.
[276]
400 仮取引データ、または取引データが取得できなかった場合。
35 同時処理数上限値チェッ
クエラー※3 ※4 ※5
access_denied request is crowded. [277] 400 同時に処理することのできる最大明細ファイルの数が規定値を
超過した場合。
36 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
第 5章 通信インタフェース仕様
5.3-27 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-9 異常応答電文エラーコード(総合振込、給与・賞与振込、口座振替(依頼データ登録、依頼データ照会))(4/4)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
37 OTP認証利用不可エラー
※2 ※3 ※4 ※6
access_denied otp auth is required. [202] 400 ワンタイムパスワード認証が必要な場合。
38 二経路認証利用無エラー
※2 ※3 ※4 ※6
access_denied two way auth is required. [206] 400 二経路認証が必須の場合。
※1:API連携の応答時
※2:SMBCの場合のみ発生
※3:総合振込依頼データ登録の場合に発生
※4:給与・賞与振込依頼データ登録の場合に発生
※5:口座振替依頼データ登録の場合に発生
※6:総合振込依頼データ照会の場合に発生
※7:給与・賞与振込依頼データ照会の場合に発生
※8:口座振替依頼データ照会の場合に発生
※9:JAバンク(JASTEM)の場合のみ発生
※10:SMBCかつ総合振込依頼データ照会の場合に発生
第 5章 通信インタフェース仕様
5.3-28 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
(10)振込振替、総合振込(依頼データ承認要求、依頼データ承認応答)
表 5.3.1-10 異常応答電文エラーコード(振込振替、総合振込(依頼データ承認要求、依頼データ承認応答))(1/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
1 金融機関コード取得不可
エラー
invalid_request request parameter is invalid.
[103]
400 新規セッション時に金融機関コードが取得できない場合。
2 収容金融機関コード対象
外エラー
invalid_request request parameter is invalid.
[104]
400 利用者端末が送信した金融機関コードが AnserBizSOLにて
API連携サービスを利用していない金融機関であった場合。
3 金融機関サービス利用可
能時間チェックエラー
access_denied service time is over. [211] 400 業務の利用可能時間外の場合。
4 企業認証識別子認証エラ
ー
invalid_client authentication error. [743] 401 企業認証識別子の復号に失敗した場合。
5 利用者権限チェックエラ
ー
access_denied user is not authorized. [216] 400 API連携を行うための利用者権限がない場合。
6 外部連携システム障害状
態チェックエラー※2
access_denied external system was stopped.
[244]
400 OTPセンタまたはANSERセンタの障害を検知した場合。
7 外部連携システム運転状
態チェックエラー※2
access_denied external system was stopped.
[245]
400 OTPセンタまたは ANSERセンタの運転状態異常を検知した場
合。
8 その他エラー(APIGW)
※2 ※3
server_error internal server error. [602] 500 金融機関ホストで異常処理検知した場合。
9 パス確保可否チェックエ
ラー
access_denied request is crowded. [222] 400 ログインパス取得時に輻輳が発生した場合。
10 パス確保可否チェックエ
ラー(API連携操作中)
access_denied request is crowded. [223] 400 API連携認証時にログインパスまたはホスト経路数で輻輳が発
生した場合。
11 不正リクエスト invalid_request request parameter is invalid.
[123]
400 不正なリクエストパラメータである場合。
12 アクセストークントークン
誤り
invalid_token access token is invalid. [503] 400 不正なアクセストークンによるアクセスである場合。
13 アクセストークン期限切
れエラー
invalid_token access token has expired. [504] 401 アクセストークンの有効期限が切れている場合。
14 利用中口座チェックエラ
ー※3
access_denied account is used by another user.
[231]
400 指定された口座が他の利用者により使用中である場合。
第 5章 通信インタフェース仕様
5.3-29 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
表 5.3.1-10 異常応答電文エラーコード(振込振替、総合振込(依頼データ承認要求、依頼データ承認応答))(2/2)
項
番 エラー内容 エラーコード エラーメッセージ
HTTP ステータス
コード (※1)
発生状況
15 API連携パス輻輳
※2
access_denied request is crowded. [233] 400 API連携パスの輻輳が発生した場合。
16 認証情報変更エラー
※2
access_denied authentication error. [741] 400 SMBCホストで管理する認証情報に変更があった場合。
17 認可業務チェックエラー access_denied api service was stopped. [263] 400 利用者が対象の API連携サービス(業務)を利用できない場
合。
18 金融機関ホスト輻輳拒否
報告※4
access_denied access is congestion. [266] 400 金融機関ホストの受付が混雑している場合。
19 お試し期間超過エラー
※2
access_denied trial period is over. [281] 400 無料期間が終了していて、継続申込されていない場合。
20 仮取引データ取得エラー
または取引データ取得エ
ラー※2 ※5
access_denied transaction info is unavailable.
[276]
400 仮取引データまたは、取引データが取得できなかった場合。
21 JSONパーサエラー invalid_request request parameter is invalid.
[125]
400 JSONパーサエラーが発生した場合。
22 承認実行者チェックエラ
ー
access_denied authorizer is invalid. [282] 400 利用者が取引データの承認者と一致しない場合。(ダブル承認
時の承認順序による承認者不一致も含む)
23 取引データチェックエラー
※2 ※5
access_denied transaction data is invalid. [286] 400 当該取引をAPI連携で操作できない場合。
24 OTP認証利用不可エラー
※2
access_denied otp auth is required. [202] 400 ワンタイムパスワード認証が必要な場合。
25 二経路認証利用無エラー
※2
access_denied two way auth is required. [206] 400 二経路認証が必須の場合。
※1:API連携の応答時
※2:SMBCの場合のみ発生
※3:振込振替依頼データ承認の場合に発生
※4:総合振込依頼データ承認の場合に発生
※5:SMBCかつ振込振替依頼データ承認の場合に発生
第 5章 通信インタフェース仕様
5.4-1 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.4 通信インタフェース補足
5.4.1 残高照会応答電文の自動変換について AnserBizSOLでは、残高照会応答電文において、企業様へ取得した値を返却する際に以下の自
動変換を実施します。
表 5.4.1-1 残高照会応答電文の自動変換
項番 項目 説明 1 当日残高
(※1)
「当日残高タイトル」が“融資残高”、“貸越残高”の場合は、
「当日残高」に“マイナス”を付与する。
2 前日残高
(※1)
「前日残高タイトル」が“融資残高”、“貸越残高”の場合は、
「前日残高」に“マイナス”を付与する。
3 前月末残高 「前月末残高タイトル」が“融資残高”、“貸越残高”の場合は、
「前月末残高」に“マイナス”を付与する。
4 残高の内他店券 以下のいずれかを設定する。
(1)「残高の内他店券」に値が設定されている場合、その値を
設定する。
(2)上記以外の場合、かつ「お引き出し可能金額タイトル」が
“残高の内小切手”、“残高の内他店券”の場合、「お引き出し
可能金額」に設定された値を設定する。
5 お引き出し可能金額 以下のいずれかを設定する。
(1)「お引き出し可能金額タイトル」が“お引き出し可能金額”
(0,1,2,3,C,F)の場合に金額を設定する。
(2)上記以外の場合、かつ「お引き出し可能金額タイトル」が
“お引き出し可能金額”(0,1,2,3,C,F)以外の場合は、Nullを設
定する。
※1:SMBCの場合、金融機関ホストからの応答値にマイナスが付与されているため、変換しない。
第 5章 通信インタフェース仕様
5.5-2 AnserBizSOL API連携サービス(直接企業連携)解説書<API管理基盤編>
5.5 企業識別子の暗号化方式
5.5.1 企業認証識別子の暗号化方式 企業認証識別子は、AES暗号方式で暗号化していただく必要があります。企業認証識別子の暗
号化で必要となる情報については以下のとおりです。
表 5.5.1-1 企業認証識別子の暗号化で必要となる情報
項番 項目 説明 1 暗号アルゴリズム AES
2 フィードバックモード CBC
3 パディング NoPadding
4 鍵長 256bit
5 暗号化キー クライアント IDごとに払い出された暗号化キー(8~
32byte)(※1)
6 初期化ベクトル 金融機関による申込にてお申し込みいただいた初期化
ベクトル(16byte)(※2)
※1:32byteに満たない場合、不足分を半角スペースで補充する。
※2:16byteに満たない場合、不足分を半角スペースで補充する。