電子マネー分野のオープン API に係る電文仕様標準

一般社団法人電子決済等代行事業者協会
Ver．1.0

改訂履歴
版数

発行日

Ver．1.02020 年 11 月 2 日

改定内容
・初版制定

担当者
電子決済等代行事業者協会
事務局

目次
1. はじめに..............................................................................................................................4
2. オープンＡＰＩに係る電文仕様標準の目的と位置付け.....................................................5
3. 電文仕様標準 ......................................................................................................................6
3.1 残高照会............................................................................................................................6
3.2 トランザクション照会 ......................................................................................................7
4. 今後に向けた検討事項 ........................................................................................................91. はじめに
a 本文書は、電子マネー（本書において、資金決済法第 2 条に定める前払式支払手段及び資金移動業（電子マネー以外の送金サービスを行う場合を除く）を言う。以下同様とする。）」に係る、①残高照会、②トランザクション照会を当面の対象として、API のメッセージ上の標準的な項目やその定義等の目安となる「電文仕様標準」を定めるものである。
b 全国銀行協会「オープン API のあり方に関する検討会」『オープン API のあり方に関する検討会報告書 オープン・イノベーションの活性化に向けて 」（2017 年 7 月 13日）「２．API 仕様の標準化について」（８頁）においては、銀行 API の当面の開発上の指針として、同文書で定める「電文仕様標準」のほか、API 仕様の標準化についての「基本的な考え方」、関係者が API を開発するに当たって留意すべき「開発原則」、推奨される API の基本的な仕様を定める「開発標準」の三点が定められている。本文書の参照にあたっては、これら他の指針も併せて確認されたい。
c なお、本文書は、API 連携を目指す電子マネー会社と FinTech 企業等が個別に協議して仕様を検討することや、各電子マネー会社におけるオープン API に係る戦略等を踏まえた仕様の汎用性や拡張性を確保する取組みを妨げるものではなく、むしろこれらの取組みは積極的に推奨される。

2. オープンＡＰＩに係る電文仕様標準の目的と位置付け
a「電文仕様標準」は、API のメッセージ上の標準的な項目やその定義等の目安を定めるものである。項目の規定に際し、以下 3 区分を定義する。
標準項目：各項目の定義が明確であり、且つ最低限必要と考えられるもの。
推奨項目：各電子マネー会社で実現可否や仕様が異なるものの、対応することが望ましいもの。
任意項目：各電子マネー会社で実現可否や仕様が異なるものの、可能な場合は対応が望まれるもの。
b「電文仕様標準」は、FinTech サービスにおいて使用される基本的な項目やデータについて、定義の一貫性を確保し、接続相手方において加工、集計/統合を容易化するとともに、利用者の誤認を防止し、もってオープン・イノベーションが醸成されやすい環境の実現を後押しすることを目的としている。
c「電文仕様標準」への準拠は、各電子マネー会社において検討・判断される1。また、最終的な仕様は、電文仕様標準に機械的に準拠するのではなく、API の汎用性、拡張性も十分考慮するとともに、接続相手方との協議やサービスの特性等を踏まえて、決定されることが重要である。
d「電文仕様標準」は、一般社団法人電子決済等代行事業者協会が事務局となって、電子マネー業者、IT 事業者、API 接続先企業等の各関係者の意見も参考にしつつ、取りまとめられた。今後も必要に応じて内容の追加や見直しに検討が行われること、および関係者における API 開発上の指針として参照されることを期待する。

1「電文仕様標準」は標準（Standard）であり、規則（Regulation）ではない。なお、「電文仕様標準」に準拠しようとする電子マネー会社のうち、先行して API を開発済の電子マネー会社においては、バージョンアップやリプレイス等のタイミングで準拠を目指すといった様々な取組みが考えられる。

3. 電文仕様標準
認証・認可方式については、OAuth2.0 を前提とした認証・認可を行う。
（電子マネー会社が提供している WEB サービス用の ID/PW 認証が前提）
アクセストークンの発行単位は OAuth 認
証の ID 単位によるが、各電子マネー会社で仕様が異なるため、実際の契約・開発時には事業者間での調整が必要である。

3.1 残高照会
リクエストメッセージ#項目

値の記述方法説明

特になし
レスポンスメッセージ#項目

値の記述方法

説明

標準項目
1

現在残高

数字

応答時点における現在残高2

最終取引日ISO8601 等に準じた表記

利用残高に対して最後にその変化時（取引）が発生した日時

推奨項目
3現在残高有ISO8601 等に準じた表記

効期限
4現在残高 2

現在残高に有効期限がある場合、その日付

数字「ボーナスキャッシュ」等、項目 1で管理する通常の円相当残高とは異なるが、それに準じて決済利用可
能な残高複数ある場合は 3,4 等、存在する分だけ項目を追加して良い

5現在残高 2

ISO8601 等に準じた表記

有効期限
6

ポイント数

現在残高 2 に有効期限がある場合、その日付

数字「〇〇ポイント」等、独自のポイントを保有する場合その残高

78ポイント有ISO8601 等に準じた表記

ポイントに有効期限がある場合、そ効期限の日付

更新通知

Webhook 型の通知により、アクセス負荷を双方で軽減することが望ましい
9データ反映利用日から実際に明細データが反スピードに映されるタイムラグを事前に把握係る記載できることが望ましい

3.2 トランザクション照会
リクエストメッセージ#項目値の記述方法

説明

標準項目
1

開始日

ISO8601 等に準じた表記

取得する明細の期間の初日

2終了日

ISO8601 等に準じた表記

取得する明細の期間の最終日

レスポンスメッセージ#項目

値の記述方法説明

標準項目（ページング）
1

ページング

トランザクションをページングし情報てレスポンスする場合に必要となる各種情報
ページング仕様は各社にあったものとして良い

標準項目（取引明細）
2

トランザク

各社で自由な形式

ション ID
3

取引種別

明細を識別するための識別子。再利用のないユニークな ID

システム的な区分値となるも 「決済」「チャージ」「送金」「受取」の「決済キャンセル」「キャッシュバック」など、その取引がどのような種類のものか各社オリジナルの取引種別もある
ため、業務的な定義は別途各社ごとに定める

4

取引日時

ISO8601 等に準じた表記

そのトランザクションが発生した
日時

5

金額数字

そのトランザクションによって残高に発生した増減額

6

摘要

フリーテキスト

トランザクションを補足する摘要文字列情報
決済の場合は加盟店名や、送金の場
合は送金相手名等
推奨項目
8

更新通知

Webhook 型の通知により、アクセス負荷を双方で軽減することが望ましい

9

データ反映

利用日から実際に明細データが反スピードに映されるタイムラグを事前に把握係る記載できることが望ましい4. 今後に向けた検討事項a

電子マネーの利用時には、電子マネー会社が発行するポイントが併用されることも多い。その取り扱い等につき、以下を今後の改定に向けた検討事項として記載する。
#

項目 or 記載内容

説明・備考

1

出金でのポイン

入出金もポイント利用額が分かる構成が望ましい

ト利用額
2
3

割引やキャッシ割引やキャッシュバックがある場合は、別途、金額が分かれてュバックいることが望ましい

加盟店の「業種」 加盟店の「業種」は課税区分の判明に有益な情報であるため記載があることが望ましい

45

キャンセルや修加盟店によるキャンセルや修正時に、現状想定されている入出正時に係る処理

金レスポンスで問題ないのかの確認（ポイント関係の取り扱いに係る項目がどうなるかを含む）ができることが望ましい

後払い処理およ

後払いに関係する処理方法の確認。クレジットカードと同様にび利用内容の確確定・未確定がある場合にはその情報の記載が望ましい

定・未確定に係る項目
6

1 つの購買で複数

1 つの購買で複数の決済手法が使われた場合（チャージ残高利の決済手法が使用とオートチャージが行われた場合など）、1 つの決済情報としわれた場合の処て記載されるかを検討

理に係る項目