クレジットカード分野のオープン API に係る電文仕様標準

一般社団法人キャッシュレス推進協議会
Ver. 1.0

改訂履歴
版数

発行日

Ver. 1.0

2019 年 10 月 30 日

改訂内容
 制定

担当者
キャッシュレス推進協議会「API ガイドラインの整備」
プロジェクト目次
1

はじめに .......................................................................................................................... 12

電文仕様標準の目的と位置付け...................................................................................... 23

電文仕様標準 ................................................................................................................... 3
3.1

カード情報照会 ........................................................................................................ 43.2

取引明細 ................................................................................................................... 53.3

請求履歴紹介............................................................................................................ 7

3.4

ポイント残高照会 .................................................................................................... 93.5

利用可能額照会 ...................................................................................................... 10

1 はじめにa

本文書は、「クレジットカードデータ利用に係るAPIガイドライン」1（以下、同ガイドラインという）を踏まえ、クレジットカードに係る、①カード情報照会、②取引明細、③
請求履歴照会、④ポイント残高照会、⑤利用可能額照会を当面の対象として、APIのメッセージ上の標準的な項目やその定義等の目安となる「電文仕様標準」を定めるものである。

b

同ガイドライン「API 仕様の標準化について」（9頁）においては、当面の API 開発上の指針として、本文書で定める「電文仕様標準」のほか、関係者が API を開発するに当たって留意すべき「開発原則」、推奨される API の基本的な仕様を定める「開発標準」の三点が定められている。本文書の参照にあたっては、これら他の指針も併せて確認されたい。

c

なお、本文書は、API 連携を目指すクレジットカード会社と FinTech 企業等が個別に協議して仕様を検討することや各 クレジットカード会社におけるオープンAPI に 係 る 戦 略 等 を 踏 ま え た 仕 様 の汎用性や拡張性を確保する取組みを妨げるものではなく、むしろこれらの取組みは積極的に推奨される。
図表 1【参考】開発原則、開発標準、電文仕様標準の関係［開発標準］ 推奨される API の基本的な仕様
電文仕様全体（出典）オープン API のあり方に関する検討会「オープン API のあり方に関する検討会報告書－オープン・イノベーションの活性化に向けて－」（2017 年 7 月 13 日）

12018 年 4 月 11 公表の第一般。原文はhttp://www.meti.go.jp/report/whitepaper/data/20180411001.html から入手可能。なお、2019 年 3 月
29 日改訂案より「キャッシュレス決済データ利用に係る API ガイドライン」に名称変更

1

2 電文仕様標準の目的と位置付けa「電文仕様標準」は、API のメッセージ上の標準的な項目やその定義等の目安を定めるものである。項目の規定に際し、以下 3 区分を定義する。
標準項目 ： 各項目の定義が明確であり、且つ最低限必要と考えられるもの。
推奨項目 ： 各クレジットカード会社で実現可否や仕様が異なるものの、対応することが望ましいもの。
任意項目 ： 各クレジットカード会社で実現可否や仕様が異なるものの、可能な場合は対応が望まれるもの。

b「電文仕様標準」は、FinTech サービスにおいて使用される基本的な項目やデータについて、定義の一貫性を確保し、接続相手方において加工、集計/統合を容易化するとともに、利用者の誤認を防止し、もってオープン・イノベーションが醸成されやすい環境の実現を後押しすることを目的としている。

c「電文仕様標準」への準拠は、各クレジットカード会社において検討・判断される2。
また、最終的な仕様は、電文仕様標準に機械的に準拠するのではなく、API の汎用性、拡張性も十分考慮するとともに、接続相手方との協議やサービスの特性等を踏まえて、決定されることが重要である。

d「電文仕様標準」は、一般社団法人キャッシュレス推進協議会が事務局となって、クレジットカード業界、IT事業者、API接続先企業等の各関係者の意見も参考にしつつ、取りまとめられた。今後も必要に応じて内容の追加や見直しに検討が行われること、および関係者におけるAPI開発上の指針として参照されることを期待する。

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

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

概要フロー

（出典）
【PJ18-6】API ガイドラインの整備 分科会① ISS 参照系 第 2 回検討会（2019 年 2 月 13 日）

3

3.1

カード情報照会3
カード保有者の情報照会機能を有する API の要求・応答メッセージの電文仕様標
準を以下のとおりとする。

（１） 要求メッセージ
♯項目

説明

留意事項

アクセストークン

OAuth 認証により付与されたアクセ

カード会社ごとに付与される単位

ストークンが異なる（契約単位・本カード単標準項目1位・カード単位）（２） 応答メッセージ
♯項目

説明

留意事項

内部管理用番号

カードを特定する ID で、例えば紛標準項目
1失で新しい番号が採番されても変わらない値
2

カード名義人

カードの名義人で、個人を特定・区
別3

イシュアー名

当該カードの発行会社名

4

カード名称

利用者が理解するカード名称（券面にある名前など）

5

カード種類

親カ ード・ 家族 カ ードな ど（ ETC 、提供可能なカード種類についてID、QuickPay など）

各社に確認が必要

推奨項目
6

7

カードの国際Visa/Master/JCB/AMEX/Diners な

ブランド

どの区分

カード番号

利用者が理解可能な範囲でマスキ各社と協議の 上でマスキン グ方(マスキング)

ングされたカード番号法、セキュリティ上の考慮が必要

3

カード情報照会 API がない場合（アクセストークンの発行単位が親カード単位の場合など）においては、取引明細 API などにおいて対象カードを特定できる形での返答も考えられる

4

3.2

取引明細
カード保有者がカードを利用した取引の明細確認機能を有する API の要求・応答
メッセージの電文仕様標準を以下のとおりとする。

（１） 要求メッセージ
♯

項目

説明

留意事項

アクセストークン

アクセストークン（およびカード情報アクセストークンのみでカードが特(および内部照会で取得した内部管理用番号）定できないカード会社の場合は、標準項目
1管理用番号)
2請求月

内部管理用番号が必須
照会対象の請求月

取引月で指定できる場合は不要

任意項目
3

取引月

照会対象の利用月（２） 応答メッセージ
♯

項目

説明

留意事項

標準項目
1

取引日付

ISO 標準に準拠

NULL は原則不可だが、年会費などの取引日のない明細も存在

2

取引利用金額

当該取引の利用金額

3

加盟店名・当該取引の利用加盟店・利用内容

利用内容
4

利用区分

文字数制限などは各社に確認が必要

ショッピング、もしくはキャッシングの区分

5

支払区分

一回払、リボ、分割の区分

6

支払回数

分割の場合の支払回数

7

請求月

明細の該当月8

確定ステータス

確定、もしくは未確定明細の区分

取引月で照会された場合

5

推奨項目
9

取引の利用金額

特典などによる支払額の減額

（割引）
10

子カード利用ETC、家族カード、iD、QuicPay など（親カードで要求した場合）

11

海外利用通貨海外取引時の通貨

12

海外利用金額

海外取引における利用金額

13

海外換算レート

当該海外取引の換算レート

14

海外換算日付

当該海外取引の換算日付

任意項目
15

取引時間

当該取引の利用時間

16

オーソリ番号

当該取引のオーソリ番号

17

取引国

当該取引の利用国名

6

3.3

請求履歴紹介カード利用者の特定月の請求履歴照会機能を有する API の要求・応答メッセージの電文仕様標準を以下のとおりとする。

（１） 要求メッセージ
♯

項目

説明

留意事項

アクセストークン

アクセストークン（およびカード情報アクセストークンのみでカードが特(および内部照会で取得した内部管理用番号）定できないカード会社の場合は、標準項目
1

管理用番号)

内部管理用番号が必須

推奨項目
2

請求月

明細の該当月月の指定は必須（２） 応答メッセージ
♯項目

説明

留意事項

標準項目
1

請求月

明細の該当月2支払日

当該請求の支払日

3金額請求金額

各社で商品性が相違するため、当該金額にどの商品が含まれるか確認が必要

4

確定ステータス

確定、もしくは未確定明細の区分

推奨項目
5

締め日

請求確定日

767

支払口座：

当該請求の引落口座（金融機関各社とセキュリティ観点での協議金融機関名名）が必要

支払口座：

当該請求の引落口座（支店名）

各社とセキュリティ観点での協議

支店名

89が必要

支払口座：

当該請求の引落口座（マスキング済

各社とセキュリティ観点での協議

口座番号みの口座番号）が必要

支払口座：

当該請求の引落口座（口座種別）

各社とセキュリティ観点での協議

口座種別

10

支払明細：

が必要

ショッピング利用における支払明細

ショッピング

1112

支払明細：

ショッピングリボ・分割払利用におけリボ・分割る支払明細

支払明細：

キャッシングにおける支払明細

キャッシング8

3.4

ポイント残高照会
カード会社が提供するポイント機能について、カード保有者の残高照会機能を有する
API の要求・応答メッセージの電文仕様標準を以下のとおりとする。

（１） 要求メッセージ♯項目

説明留意事項

アクセストークン

アクセストークン（およびカード情報

アクセストークンのみでカードが特(および内部照会で取得した内部管理用番号）定できないカード会社の場合は、標準項目
1管理用番号)

内部管理用番号が必須（２） 応答メッセージ
♯

項目

説明

留意事項

標準項目
1

ポイント名称

当該ポイントの名称

一部提供不可のカードが存在する可能性あり

2

ポイント残高照会時点での当該ポイントの残高一部提供不可のカードが存在する可能性あり

3

システム応答カード会社等におけるポイント管理

日付システムからの応答日付

推奨項目
3

ポイント有効ポイントの有効期限が存在する場合

期限のみ応答93.5

利用可能額照会
カード保有者の契約上利用可能残高照会機能を有する API の要求・応答メッセージの電文仕様標準を以下のとおりとする。

（１） 要求メッセージ
♯項目

説明

留意事項

アクセストークン

アクセストークン（およびカード情報

アクセストークンのみでカードが特(および内部照会で取得した内部管理用番号）定できないカード会社の場合は、標準項目
1管理用番号)2

内部管理用番号が必須

システム応答カード会社等における利用額管理

日付

システムからの応答日付（２） 応答メッセージ
♯

項目

説明

留意事項

標準項目
1

総枠

利用枠の総計

利用枠の考え方が各社によって相違するため定義の確認が必要

推奨項目
2

3

4

ショッピング枠

キャッシング枠

ショッピング

照会時点で設定されているショッピ

利用枠の考え方が各社によってング利用枠相違するため定義の確認が必要

照会時点で設定されているキャッシ

利用枠の考え方が各社によってング利用枠相違するため定義の確認が必要

照会時点でのショッピング利用残高利用枠の考え方が各社によって利用額56相違するため定義の確認が必要

キャッシング

照会時点でのキャッシング利用残利用枠の考え方が各社によって利用額高相違するため定義の確認が必要

ショッピング

照会時点で利用可能なショッピング

利用枠の考え方が各社によって利用可能額

利用枠相違するため定義の確認が必要

10

7

キャッシング

照会時点で利用可能なキャッシン

利用枠の考え方が各社によって利用可能額

グ利用枠相違するため定義の確認が必要

ショッピングリボ・

照会時点で設定されているショッピ

利用枠の考え方が各社によって分割払枠

ングリボ・分割払利用枠相違するため定義の確認が必要

ショッピングリボ・

照会時点でのショッピングリボ・分割利用枠の考え方が各社によって分割払利用額

払利用残高相違するため定義の確認が必要

ショッピングリボ・ 照会時点で利用可能なショッピングリ利用枠の考え方が各社によって分割払利用相違するため定義の確認が必要

任意項目
8910

ボ・分割払利用枠可能額

11