BT11 プロトコルタイプ (カード決済ブランドトークンインタフェース仕様)

ＰＧマルチペイメントサービス
プロトコル・タイプ
(ApplePay(ブランドトークン)決済インタフェース仕様)
2022 年 04 月 19 日 1.03 版
Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -1 -

本書の著作権は「GMO ペイメントゲートウェイ株式会社(以下、弊社という)」に帰属します。
本書のいかなる部分においても、弊社に事前の書面による許可なく、電子的、機械的を含むいかなる手段や形式によっても
その複製、改変、頒布、ならびにそれらに類似する行為を禁止します。
本仕様書は加盟店様と弊社との間で締結した機密保持契約において機密情報として規定される情報です。本仕様書の取扱い
は機密保持契約の規定に従ってください。
本書の内容は、予告なく随時更新されます。
本書の内容について万全を期しておりますが、万一記載もれ等お気づきの点がございましたら、当社までご連絡下さい。
目次
1. はじめに .......................................................................................................................................................... 5
1.1. 提供される機能 ......................................................................................................................................... 5
1.2. 開発するにあたっての注意事項 ................................................................................................................... 7
1.2.1. 取引について ..................................................................................................................................... 7
1.2.2. トークンについて ............................................................................................................................... 7
1.2.3. トークンの登録について ..................................................................................................................... 7
1.2.4. 本サービスのタイムアウトについて ...................................................................................................... 8
2. インタフェース仕様 .......................................................................................................................................... 9
2.1. 全インタフェースに共通する仕様 ................................................................................................................ 9
2.2. ApplePay(ブランドトークン)決済を行う ..................................................................................................... 10
2.2.1. ApplePay(ブランドトークン)決済の流れ ............................................................................................. 10
2.2.2. 各インタフェース仕様詳細 ................................................................................................................ 11
2.3. オーソリを取り消す ................................................................................................................................. 15
2.3.1. オーソリを取り消す流れ ................................................................................................................... 15
2.3.2. 各インタフェース仕様詳細 ................................................................................................................ 16
2.4. 売上の確定を行う .................................................................................................................................... 18
2.4.1. 実売上を行う流れ ............................................................................................................................. 18
2.4.2. 各インタフェース仕様詳細 ................................................................................................................ 19
2.5. 返品を行う.............................................................................................................................................. 21
2.5.1. 返品を行う流れ ................................................................................................................................ 21
2.5.2. 各インタフェース仕様詳細 ................................................................................................................ 22
2.6. 金額の変更を行う .................................................................................................................................... 24
2.6.1. 金額変更を行う流れ .......................................................................................................................... 24
2.6.2. 各インタフェース仕様詳細 ................................................................................................................ 25
2.7. ApplePay(ブランドトークン)情報を登録する .............................................................................................. 27
2.7.1. ApplePay(ブランドトークン)登録の流れ ............................................................................................. 27
2.7.2. 各インタフェース仕様詳細 ................................................................................................................ 28
2.8. ApplePay(ブランドトークン)情報の削除をする ........................................................................................... 30
2.8.1. ApplePay(ブランドトークン)削除の流れ ............................................................................................. 30
2.8.2. 各インタフェース仕様詳細 ................................................................................................................ 31
2.9. ApplePay(ブランドトークン)情報を参照する .............................................................................................. 32
2.9.1. ApplePay(ブランドトークン)参照の流れ ............................................................................................. 32
2.9.2. 各インタフェース仕様詳細 ................................................................................................................ 33
2.10. 決済結果を参照する ............................................................................................................................. 35
2.10.1. 取引状態参照の流れ .......................................................................................................................... 35
2.10.2. 各インタフェース仕様詳細 ................................................................................................................ 36
2.11. 決済結果の通知を受け取る .................................................................................................................... 38
2.11.1. 各インタフェース仕様詳細 ................................................................................................................ 38

変更履歴
2016 年 11 月 28 日– 1.00 版
・新規作成
2017 年 10 月 16 日 – 1.01 版
・「ブランドトークン」から「ApplePay(ブランドトークン)」に表記を変更
2021 年 02 月 16 日 – 1.02 版
・「返金」から「返品」に表記を変更
2022 年 04 月 19 日 – 1.03 版
・会員ID決済、金額変更、ApplePay(ブランドトークン)登録にてVISAブランドが利用できない説明を追加

1. はじめに
この仕様書は、マルチペイメントサービスにて、端末取得方式の ApplePay(ブランドトークン)でクレジットカード
決済を行うための、API 仕様書となります。
本書では、以下の表記を使用致します。
『』: 処理状態または処理区分
【】: インタフェース名
1.1. 提供される機能
ApplePay(ブランドトークン)決済において提供される機能と、実行するための API は以下の通りです。
表 1.1-1 提供される機能
No 項目説明（設定値表記を含む）
1 ApplePay(ブランドトーク取引登録API【EntryTranBrandtoken】＋決済実行API【ExecTranBrandtoken】
ン)決済を行うオーソリを実行します。パラメータにより、与信枠の確保のみ行うか、オーソリ時
に売上確定とするか制御します。
2 オーソリを取り消す決済取消API【VoidTranBrandtoken】
一度オーソリ取得した取引に対し、与信枠を取り消します。売上が未確定の取引に
対して実行可能です。売上確定後の取引を取り消す場合、下記”返品API”をご利用く
ださい。
なお、一度取り消した取引を有効にすることはできません。
3 売上の確定を行う実売上API【SalesTranBrandtoken】
オーソリ済の取引に対し、売上の確定を行います。
4 返品を行う返品API【RefundTranBrandtoken】
売上確定済の取引に対し、返品処理を行います。この処理は確定済の取引のみ実行
可能です。確定前の取引を取り消す場合、”決済取消API”をご利用ください。
なお、一度返品した取引を有効にすることはできません。
5 金額変更を行う実売上API【ChangeTranBrandtoken】
決済が完了した取引に対し、金額の変更を行います。内部的に決済取消／返品と決
済実行を実施します。
6 ApplePay(ブランドトーク ApplePay(ブランドトークン)登録API【TradedBrandtoken】
ン)情報を登録する指定した会員にApplePay(ブランドトークン)情報を登録します。
7 ApplePay(ブランドトーク ApplePay(ブランドトークン)削除API【DeleteBrandtoken】
ン)情報を削除する指定した会員のApplePay(ブランドトークン)情報を削除します。
8 ApplePay(ブランドトーク ApplePay(ブランドトークン)参照API【SearchBrandtoken】
ン)情報を参照する会員に登録されているApplePay(ブランドトークン)情報を返却します。
9 決済結果を照会する取引状態参照API【SearchTradeMulti】
取引を照会し、その状態を確認できます。
10 決済結果の通知を受け取る結果通知 (HTTPsによる、マルチペイメントから加盟店様へのPush通知)
取引の状態が変更されるたび、通知されます。
(オーソリを取得した、取り消された、等)
利用は任意で、利用する場合管理画面から受信するURLを設定します。

表 1.1-2 取引状態の遷移について
操作が実施できる
操作操作結果操作後の状態結果通知対象
取引状態
取引登録－－未決済（UNPROCESSED）
仮売上（AUTH）
成功
決済実行未決済即時売上（CAPTURE） ○
失敗操作前の状態
成功実売上（SALES）
実売上仮売上 ○
成功取消（VOID）
決済取消仮売上 ○
成功返品（RETURN）
返品実売上／即時売上 ○
仮売上（AUTH）
仮売上／実売上成功 ○
金額変更即時売上（CAPTURE）
／即時売上
失敗操作前の状態 ○

1.2. 開発するにあたっての注意事項
ここでは、プロトコル・タイプで開発する際の注意事項を説明致します。
1.2.1. 取引について
以下に、取引内容に付いての注意事項を説明致します。
取引の削除
本サービスは、取引の削除は出来ません。結果にエラーがあった場合も例外ではありませんのでご注意ください。
そのため、オーダーID に注文書番号等の変更が出来ない番号は使用しないで下さい。どうしても、使用しなくてはいけ
ない場合は、注文番号+連番のような発番ルールを推奨いたします。
仮売上後の実売上
仮売上のオーソリ実施後 90 日を越えて売上の確定を行うとエラーとなります。運用上 90 日を越える事が想定される場
合は、仮売上の取り消しを実施後に再度オーソリを行う必要があります。
なお、再度オーソリを行った場合に、お客様のカードの状況によっては、有効期限エラーまたは利用限度額超過エラー等
が発生する場合がございます。（詳細な理由に関してはお客様の個人情報にも関わりますため、お客様（カード会員）から
カード券面に記載のカード発行会社へお問い合わせください。）
1.2.2. トークンについて
本決済手段では、トークン形式に変換されたカード番号を利用します。トークンは、16 桁数値のカード番号と同様のフ
ォーマットを持ちますが、カード番号そのものではありません。以降、文中ではカード番号を”トークン”と記述します。
※当社の提供する、javascript 方式のワンタイムトークンとは異なります。ご注意ください。
1.2.3. トークンの登録について
クレジットカード決済と同様に、トークンも会員 ID と紐付けて登録することが可能です。
通常のクレジットカードとの使い分け
通常のクレジットカードとトークンは、異なる種類のデータとして扱われます。インターフェースや登録枚数などはそれ
ぞれ対応したものを利用する必要があります。
登録上限
1 会員につき、5 枚まで登録可能です。6 枚以上登録する場合には、登録済みのトークンを削除する必要があります。
登録済みトークンの連番管理
トークンの管理連番には、論理と物理の二種類があります。これらは、連番を指定する場面(決済実行時、登録トークン
の参照時)に連番モードとして、連番とあわせて指定して使い分けます。
論理連番は、常に 0 から始まる番号です。登録済みトークンを削除した場合、再計算され 0 から振り直されます。
物理連番は、登録した際の番号で固定となり、削除した場合でも変更されません。

1.2.4. 本サービスのタイムアウトについて
本サービスが、外部システムとの通信を行う際に使用するタイムアウトについて説明致します。
【決済実行】・【決済取消】の各処理時にカード会社と通信を行っています。処理の遅延を考慮して、本サービスでは 60
秒でタイムアウトが発生致します。加盟店様では、60 秒+αの値を本サービスとのタイムアウト値として設定して下さい。
推奨する値は 90 秒程度となります。
また、タイムアウトが発生した場合は、一定時間後に取引照会等で決済の整合性を確認してください。

2. インタフェース仕様
ここでは、各目的に対して処理の流れと使用するインタフェース詳細について説明致します。各インタフェースの呼び出
しは HTTPS 通信にて行う必要があります。
2.1. 全インタフェースに共通する仕様
・文字コード：Shift_JIS
・Content-Type：application/x-www-form-urlencoded
・METHOD：POST
・レスポンスは、パラメータ=value を&で結合した文字列で返却されます。
key1=value1&key2=value2…

2.2. ApplePay(ブランドトークン)決済を行う
端末から取得したトークンを使用してカード会社と通信を行い、決済を行います。
また、事前に会員に登録した ApplePay(ブランドトークン)情報を使用して決済を行うことも可能です。
会員 ID 決済では、VISA ブランドをご利用いただけません。
2.2.1. ApplePay(ブランドトークン)決済の流れ
以下に ApplePay(ブランドトークン)決済の流れをご説明します。
購入商品・金額の確定加盟店様における処理
【取引登録】本サービスにおける処理
端末からトークンを取得 3 加盟店様における処理
【決済実行】本サービスにおける処理
結果表示 6 加盟店様における処理
図 2.2.1-1 ApplePay(ブランドトークン)決済の流れ
流れの説明
1. 加盟店様は、確定された金額をもって本サービスの【取引登録】を呼び出します。
2. 本サービスは、取引を識別する ID とパスワードを発行し、返します。
3. 加盟店様は、アプリケーションでエンドユーザー操作によりトークンを取得します。
4. 加盟店様は、取得したトークンをもって本サービスの【決済実行】を呼び出します。
5. 本サービスは、トークンを使用してカード会社との通信を行い、決済を実施し結果を返します。
6. 加盟店様は、決済の結果をお客様に表示します。
2.2.2. 各インタフェース仕様詳細
2.2.2.1. 取引登録
接続先 URL
/payment/EntryTranBrandtoken.idPass
インタフェース概要
これ以降の決済取引で必要となる取引 ID と取引パスワードの発行を行い、取引を開始します。
入力パラメータ(加盟店様⇒本サービス)
各パラメータ値を POST で送信します。

必
No パラメータ名型桁意味備考
須
パラメータバージョン
1 VerSion CHAR 3 パラメータバージョン
(予約項目のため、省略して下さい。)
2 ShopID ◎ CHAR 13 ショップID 弊社が発行する値を設定します。
3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。
加盟店様が取引を識別するための値を設定し
4 OrderID ◎ CHAR 27 オーダーID
ます。
以下のいずれかを設定します。
5 JobCd ◎ CHAR - 処理区分 CAPTURE：即時売上
AUTH：仮売上
通常は省略してください。カード会社から指
定がある場合のみ、その値を設定します。省
6 ItemCode CHAR 7 商品コード(※1) 略時は"0000990"を適用します。
加盟店様で管理されている商品のコード等を
設定されないよう、ご注意ください。
金額を指定します。1から9,999,999の整数を
7 Amount ◎ NUMBER 7 利用金額指定します。
日本円のみ対応しております。
税送料を指定した場合は、利用金額+税送料が
8 Tax NUMBER 7 税送料
決済金額となります。
【必須項目の記号 ◎：必須 ●：条件により必須空白：省略可能 -：出力時】
※1：通常は省略してください。カード会社との間の契約で使用する商品コードが決められた場合のみ設定してください。
出力パラメータ(本サービス⇒加盟店様)
各パラメータ値を"&"で結合したパラメータを出力します。
必
須
発行したIDを返却します。
1 AccessID - CHAR 32 取引ID ※同一オーダーIDでも決済手段が異なると、
異なった「取引ID」および「取引パスワード」
が返却されます。
発行したパスワードを返却します。
2 AccessPass - CHAR 32 取引パスワード ※同一オーダーIDでも決済手段が異なると、
異なった「取引ID」および「取引パスワード」
が返却されます。
エラー発生時のみ値を返却します。
3 ErrCode - CHAR 3 エラーコード
複数ある場合は"|"で接続された文字列(※1)
4 ErrInfo - CHAR 9 エラー詳細コード
複数ある場合は"|"で接続された文字列(※1)
※1：複数エラーがある場合は下記のような形式にて出力されます。(必ず、ErrCode の n 番目と ErrInfo の n 番目が対となります)
ErrCode=E01|E01|E01|E01|E01&ErrInfo=E01010001|E01020001|E01030002|E01040001|E01060001
2.2.2.2. 決済実行
接続先 URL
/payment/ExecTranBrandtoken.idPass
端末から取得したトークン、または事前に会員に登録した ApplePay(ブランドトークン)情報を使用して、カード会社
と通信を行い決済を実施し、結果を返します。

No パラメータ名必須型桁意味備考
2 ShopID ◎ CHAR 13 ショップID 【取引登録】で指定した値を設定します。
3 ShopPass ◎ CHAR 8 ショップパスワード【取引登録】で指定した値を設定します。
4 AccessID ◎ CHAR 32 取引ID 【取引登録】で発行された値を設定します。
5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。
6 OrderID ◎ CHAR 27 オーダーID 【取引登録】で指定した値を設定します。
利用するトークンの取得元を設定します。
7 TokenType ● CHAR 8 トークン種別現在、以下のコードに対応しています。
“APay”
端末から取得したトークンを設定してください。
TokenTypeが”APay”の場合：
端末で取得したpaymentトークンをbase64エン
8 Token ● CHAR - トークン
コードして送信してください。
※トークンが指定された場合、No7は必須となり、
No9,10,11は無視されます。
9 SiteID ● CHAR 13 サイトID 弊社が発行する値を設定します。
10 SitePass ● CHAR 10 サイトパスワード弊社が発行する値を設定します。
11 MemberID ● CHAR 60 会員ID 決済する対象の会員IDを設定します。
0：論理(省略値)
12 SeqMode CHAR 1 連番モード 1：物理
利用するトークンの連番指定モード。
複数トークンを登録している会員について、どの
トークンを利用するか番号で指定する。省略した
13 TokenSeq NUMBER 4 トークン連番
場合、トークンの登録時に指定したDefaultFlagが
指定されたものを利用する。
14 ClientField1 CHAR 100 加盟店自由項目1 自由に設定して下さい。

必
須
決済実行された結果の状態を返却します。
“AUTH”：仮売上
1 Status - CHAR 16 取引状態
“CAPTURE”：即時売上
“UNPROCESSED”：未決済（決済失敗）
【決済実行】呼出時に指定した値を返却しま
2 OrderID - CHAR 27 オーダーID
す。
与信を行ったカード会社の会社コードを返却
3 Forward - CHAR 7 仕向先コード
します。
カード会社が発行した与信の承認番号を返却
4 Approve - CHAR 7 承認番号
します。
弊社が処理を行う毎に発行している処理番号
5 TranID - CHAR 28 トランザクションID
を返却します。
【決済実行】を実施した日時を返却します。
6 TranDate - CHAR 14 決済日付
(yyyyMMddHHmmss形式)
7 ClientField1 - CHAR 100 加盟店自由項目1

【決済実行】時に指定した値をそのまま返却
します。
10 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)と
なります。
11 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)と
なります。
2.3. オーソリを取り消す
決済が完了した取引の取引 ID・取引パスワードを指定すると、以前に実施した決済内容を取り消すこと(以下、決済取消)
が可能です。
※ 決済の取り消しを行っても与信枠はすぐに戻らない場合があります。
与信枠への反映はカード会社によってタイミングが異なっています。
2.3.1. オーソリを取り消す流れ
以下に決済の内容を取り消す流れをご説明します。
決済の指定加盟店様における処理
【決済取消】本サービスにおける処理
結果確認 3 加盟店様における処理
図 2.3.1-1 決済取消の流れ
流れの説明
1. 加盟店様は、変更する取引の取引 ID と取引パスワードを指定し、本サービスの【決済取消】を
呼び出します。
2. 本サービスは、カード会社と通信を行い、決済内容の取り消しを実施し結果を返します。
3. 加盟店様は、決済取消の結果を確認します。
2.3.2.1. 決済取消
接続先 URL
/payment/VoidTranBrandtoken.idPass
決済が完了した取引に対して決済内容の取り消しを行います。指定された取引情報を使用してカード会社と通信を行い
取り消しを実施します。

必
No パラメータ名型桁意味説明
須

必
須
1 AccessID - CHAR 32 取引ID 【決済取消】呼出時に指定した値を返却します。
2 AccessPass - CHAR 32 取引パスワード【決済取消】呼出時に指定した値を返却します。
【決済取消】を実行した結果の取引ステータスで
す。
3 Status CHAR 16 取引状態 “VOID”：取消
※処理に失敗した場合、決済取消要求前の状態が
返却されます。
与信を行ったカード会社の会社コードを返却し
ます。
カード会社が発行した与信の承認番号を返却し
ます。
弊社が処理を行う毎に発行している処理番号を
返却します。
与信を実施した日付を返却します。
8 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)とな
ります。
9 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)とな
ります。
2.4. 売上の確定を行う
オーソリを取得した取引に対して売上の確定を行い、カード会社に対して請求を行います。
2.4.1. 実売上を行う流れ
以下に実売上を行う流れをご説明します。
【実売上】本サービスにおける処理
図 2.4.1-1 実売上の流れ
流れの説明
1. 加盟店様は、実売上する取引の取引 ID と取引パスワードを指定し、本サービスの【実売上】を
2. 本サービスは、指定された取引をカード会社請求対象としてマークします。
3. 加盟店様は、実売上の結果を確認します。
2.4.2.1. 実売上
接続先 URL
/payment/SalesTranBrandtoken.idPass
オーソリを取得した取引に対して、売上を確定します。

必
須
【取引登録】で指定した値を設定します。
7 Amount ◎ NUMBER 7 確定金額オーソリ金額から増額／減額した確定はでき
ません。
8 Tax NUMBER 7 確定税送料オーソリ金額から増額／減額した確定はでき
ません。
必
須
1 AccessID - CHAR 32 取引ID 【実売上】呼出時に指定した値を返却します。
2 AccessPass - CHAR 32 取引パスワード【実売上】呼出時に指定した値を返却します。
【実売上】を実行した結果の取引ステータス
です。
3 Status CHAR 16 取引状態 “SALES”：実売上
※確定に失敗した場合、確定要求前の状態が
します。
します。
なります。
なります。
2.5. 返品を行う
売上を確定した取引に対して、返品を行います。
2.5.1. 返品を行う流れ
以下に返品を行う流れをご説明します。
【返金】本サービスにおける処理
図 2.5.1-1 返品の流れ
流れの説明
1. 加盟店様は、売上を確定した取引の取引 ID と取引パスワードを指定し、本サービスの【返品】を
2. 本サービスは、指定された取引を返品対象としてマークします。
3. 加盟店様は、返品の結果を確認します。
2.5.2.1. 返品
接続先 URL
/payment/RefundTranBrandtoken.idPass
売上を確定した取引に対して、返品を行います。

必
須
7 Amount ◎ NUMBER 7 返品金額確定時から減額／増額した返品はできませ
ん。
8 Tax NUMBER 7 返品税送料確定時から減額／増額した返品はできませ
ん。
必
須
1 AccessID - CHAR 32 取引ID 【返品】呼出時に指定した値を返却します。
2 AccessPass - CHAR 32 取引パスワード【返品】呼出時に指定した値を返却します。
【返品】を実行した結果の取引ステータスで
す。
3 Status CHAR 16 取引状態 “RETURN”：返品
※返品に失敗した場合、返品要求前の状態が
します。
します。
なります。
なります。
2.6. 金額の変更を行う
決済が完了した取引の取引 ID・取引パスワードを指定すると、以前に実施した決済内容の金額を変更すること(以下、金
額変更)が可能です。
内部的に、決済取消／返品と決済実行を実施した結果を返します。そのため、金額変更を実施した場合は取引履歴に決済
取消／返品と決済実行の 2 件が作成されます。
なお、決済取消／返品と決済実行にエラーが発生した場合は、処理前の取引状態に戻ります。その際、取引履歴には取消
／返品または決済実行のどちらか 1 件が作成されます。
本処理では、VISA ブランドをご利用いただけません。
2.6.1. 金額変更を行う流れ
以下に金額変更を行う流れを説明致します。
【金額変更】本サービスにおける処理
図 2.6.1-1 金額変更の流れ
流れの説明
1. 加盟店様は、金額変更する取引の取引 ID と取引パスワードを指定し、本サービスの【金額変更】を
2. 本サービスは、指定された処理区分に対する処理をカード会社と通信を行い実施します。
3. 加盟店様は、金額変更の結果を確認します。
2.6.2.1. 金額変更
接続先 URL
/payment/ChangeTranBrandtoken.idPass
決済が完了した取引に対して金額の変更を行います。

必
須
以下のいずれかを設定
CAPTURE：即時売上
AUTH：仮売上
7 JobCd ◎ CHAR - 処理区分
※金額変更後に該当する処理区分を指定して
ください。
8 Amount ◎ NUMBER 7 利用金額変更後の利用金額を設定します。
9 Tax NUMBER 7 税送料

必
須
1 AccessID - CHAR 32 取引ID 【金額変更】呼出時に指定した値を返却します。
2 AccessPass - CHAR 32 取引パスワード【金額変更】呼出時に指定した値を返却します。
【金額変更】を実行した結果の取引ステータスで
す。
3 Status CHAR 16 取引状態
AUTH：仮売上
※処理に失敗した場合、処理要求前の状態が返却
されます。
与信を行ったカード会社の会社コードを返却し
ます。
カード会社が発行した与信の承認番号を返却し
ます。
弊社が処理を行う毎に発行している処理番号を
返却します。
ります。
ります。
2.7. ApplePay(ブランドトークン)情報を登録する
会員に対して ApplePay(ブランドトークン)情報を登録します。なお、登録を行う際には、決済済みの取引を元に、該当
取引で利用したトークンを登録します。
会員の登録については「プロトコルタイプ（カード決済インターフェース仕様） 2.3.会員情報を登録する」をご参照下
さい。
本処理では、VISA ブランドをご利用いただけません。
2.7.1. ApplePay(ブランドトークン)登録の流れ
以下に ApplePay(ブランドトークン)情報を登録する流れを説明致します。
決済を実行 1 加盟店様における処理
【トークン登録】本サービスにおける処理
図 2.7.1-1 ApplePay(ブランドトークン)登録の流れ
流れの説明
1. 加盟店様では、決済完了が完了されていることが前提です。
2. 加盟店様は、取得したトークンをもって本サービスの【ApplePay(ブランドトークン)登録】を
3. 本サービスは、指定された取引を元に、その取引で利用されたトークンを会員 ID と紐付けて保存し
ます。
4. 加盟店様は、登録された内容を確認します。
2.7.2.1. ApplePay(ブランドトークン)登録
接続先 URL
/payment/TradedBrandtoken.idPass
指定した会員に ApplePay(ブランドトークン)情報を登録します。

必
須
2 SiteID ◎ CHAR 13 サイトID 弊社が発行する値を設定します。
3 SitePass ◎ CHAR 10 サイトパスワード弊社が発行する値を設定します。
ApplePay(ブランドトークン)を登録する対象
4 MemberID ◎ CHAR 60 会員ID
の会員IDを設定します。
取引で利用したオーダーIDを指定します。指
7 OrderID ◎ CHAR 27 オーダーID 定された取引で使用されたトークンが登録で
きます。
0：デフォルトとしない(省略値)
1：デフォルトとする
1会員に複数のトークンを登録した場合、優先
8 DefaultFlag ● CHAR 1 デフォルトフラグ
的に利用されるカードとして設定します。複
数のトークンを登録している会員が決済する
場合、連番を省略した場合に利用されます。
1：物理
登録結果の連番を出力する際の、出力モード
です。
連番とは、1会員に複数のトークンを設定した
9 SeqMode ● CHAR 10 連番モード場合に、トークンを指し示す番号になります。
論理番号は、常に0から始まります。トークン
を削除した場合には、有効なトークンについ
て0から振りなおされます。
物理番号は、登録した際に採番された値が常
に用いられます。
必
須
登録した結果採番された、トークン連番を返
1 TokenSeq - Number 4 トークン連番
却します。
2 CardNoToken - CHAR 16 カード番号トークン登録されたトークン番号を返却します。
登録元になった決済の、仕向け先カード会社
なります。
なります。
2.8. ApplePay(ブランドトークン)情報の削除をする
登録されている ApplePay(ブランドトークン)情報の削除を行います。一度削除した ApplePay(ブランドトークン)で決済
することは出来ませんのでご注意ください。
2.8.1. ApplePay(ブランドトークン)削除の流れ
以下に ApplePay(ブランドトークン)情報を削除する流れを説明致します。
トークン情報の選択加盟店様における処理
【トークン削除】本サービスにおける処理
図 2.8.1-1 ApplePay(ブランドトークン)削除の流れ
流れの説明
1. 加盟店様は、お客様が選択した削除対象のトークン情報をもって【ApplePay(ブランドトークン)削
除】を呼び出します。
2. 本サービスは、指定された ApplePay(ブランドトークン)情報を削除します。
3. 加盟店様は、お客様に削除された内容を通知します。
2.8.2.1. ApplePay(ブランドトークン)削除
接続先 URL
/payment/DeleteBrandtoken.idPass
指定した会員の ApplePay(ブランドトークン)情報を削除します。

必
須
ApplePay(ブランドトークン)を削除する対象
4 MemberID ◎ CHAR 60 会員ID
の会員IDを設定します。
5 SeqMode ◎ CHAR 1 連番モード 1：物理
削除する連番のモードを設定します。
6 TokenSeq ◎ NUMBER 4 トークン連番削除するトークンの連番です。

必
須
1 TokenSeq - NUMBER 4 トークン連番 API呼出時に指定した値を返却します。
なります。
なります。
2.9. ApplePay(ブランドトークン)情報を参照する
会員に登録されている有効な ApplePay(ブランドトークン)情報を返します。
2.9.1. ApplePay(ブランドトークン)参照の流れ
以下に ApplePay(ブランドトークン)情報を参照する流れをご説明します。
会員 ID の指定加盟店様における処理
【トークン参照】本サービスにおける処理
図 2.9.1-1 ApplePay(ブランドトークン)参照の流れ
流れの説明
1. 加盟店様は、参照対象の会員 ID をもって【ApplePay(ブランドトークン)参照】を呼び出します。
2. 本サービスは、指定された ApplePay(ブランドトークン)情報を参照します。
3. 加盟店様は、返却された ApplePay(ブランドトークン)情報を確認します。
2.9.2.1. ApplePay(ブランドトークン)参照
接続先 URL
/payment/SearchBrandtoken.idPass
指定した会員の ApplePay(ブランドトークン)情報を参照します。

必
須
4 MemberID ◎ CHAR 60 会員ID 対象の会員IDを設定します。
5 SeqMode ◎ CHAR 8 連番種別 1：物理
参照するトークン連番の種類です。
参照するトークンの連番です。省略した場合、
会員に登録されている全てのトークン情報を
6 TokenSeq NUMBER 4 トークン連番返します。
また、連番種別で1(物理)を指定した場合、削
除済みを含む全量を返却します。
必
須
トークンの連番です。 API 呼び出し時の
1 TokenSeq - NUMBER - トークン連番
SeqModeで指定された連番を返却します。
トークンに設定されたデフォルトフラグを返
2 DefaultFlag - CHAR - デフォルトフラグ
却します。
何も設定されません。通常クレジットカード
3 CardName - CHAR - カード名称
と項目をあわせる為に設置されています。
4 CardNoToken - CHAR - カード番号トークントークン化されたカード番号を返却します。
トークンに設定された有効期限を返却しま
5 Expire - CHAR - カード有効期限
す。
トークンに設定されたカード名義人を返却し
6 HolderName - CHAR - 名義人
ます。
トークンに設定された削除フラグを返却しま
7 DeleteFlag CHAR - 削除フラグ
す。
なります。
なります。
2.10. 決済結果を参照する
オーダーID を指定すると、該当の決済結果を取得すること(以下、取引状態参照)が可能です。通信障害でタイムアウトが
発生するなどの状況で決済結果が取得できなかった場合は、本インタフェースにて取得して下さい。
2.10.1. 取引状態参照の流れ
以下に決済の結果を参照する流れをご説明します。
【取引状態参照】本サービスにおける処理
図 2.10.1-1 取引状態参照の流れ
流れの説明
1. 加盟店様は、参照する取引のオーダーID を指定し、本サービスの【取引状態参照】を呼び出します。
2. 本サービスは、指定された取引の内容を取得して返します。
3. 加盟店様は、取引の結果を確認します。
2.10.2.1. 取引状態参照
接続先 URL
/payment/SearchTradeMulti.idPass
指定したオーダーID の取引情報を取得します。

必
須
4 OrderID ◎ CHAR 27 オーダーID
参照したい取引の値を設定してください。
5 PayType ◎ CHAR 2 決済手段 27: ApplePay(ブランドトークン)

ここに提示された値は、ApplePay(ブランドトークン)決済で利用される値です。実際の返却時は、ここに記述されない
項目も返却されます。加盟店様の戻り値の切り分け処理等で、予期しないパラメータが返却された場合には無視して正
常として扱ってください。
必
須
【取引状態参照】の呼出時に指定した値を返却し
ます。
以下のいずれを返却します。
UNPROCESSED：未決済
2 Status - CHAR 15 取引状態 AUTH：仮売上
SALES：実売上
VOID：取消
RETURN：返品
処理を行った日時を返却します。
3 ProcessDate - CHAR 14 処理日時
以下のいずれかを返却します。
AUTH：仮売上
4 JobCd - CHAR 10 処理区分
SALES：実売上
VOID：取消
RETURN：返品
5 AccessID - CHAR 32 取引ID 参照した取引に設定されている値を返却します。
6 AccessPass - CHAR 32 取引パスワード参照した取引に設定されている値を返却します。
7 ItemCode - CHAR 7 商品コード参照した取引に設定されている値を返却します。
8 Amount - NUMBER 7 利用金額参照した取引に設定されている値を返却します。
9 Tax - NUMBER 7 税送料参照した取引に設定されている値を返却します。
10 SiteID - CHAR 13 サイトID 参照した取引に設定されている値を返却します。
11 MemberID - CHAR 60 会員ID 参照した取引に設定されている値を返却します。
12 CardNoToken - CHAR 16 カード番号トークントークン化されたカード番号を返却します。
13 Expire - CHAR 4 有効期限参照した取引に設定されている値を返却します。
14 Method - CHAR 1 支払方法 1：一括を返却します。
15 PayTimes - NUMBER 2 支払回数参照した取引に設定されている値を返却します。
16 Forward - CHAR 7 仕向先コード参照した取引に設定されている値を返却します。
17 TranID - CHAR 28 トランザクションID 参照した取引に設定されている値を返却します。
18 Approve - CHAR 7 承認番号参照した取引に設定されている値を返却します。
19 ClientField1 - CHAR 100 加盟店自由項目1 参照した取引に設定されている値を返却します。
22 PayType - CHAR 2 決済方法 27：ApplePay(ブランドトークン)
ります。
ります。
2.11. 決済結果の通知を受け取る
取引でイベント(オーソリ、実売上等)が発生した際、マルチペイメントからの HTTP による push 通知を利用可能です。
この機能の利用は任意となっており、ご利用する場合管理画面より設定します。
通知は、イベント発生後速やかに行われます。また、通知に失敗した場合、最大 5 回まで 60 分おきに再送されます。
受信した加盟店様では、受信した応答を返却してください。詳細な仕様は後述されます。また、加盟店様では特に不要な
通知でも、正常として応答してください。
接続先 URL
加盟店様がショップ管理画面で設定した URL
入力パラメータ(本サービス⇒加盟店様)

必
須
【取引状態参照】の呼出時に指定した値を返却し
ます。
以下のいずれを返却します。
UNPROCESSED：未決済
2 Status - CHAR 16 取引状態 AUTH：仮売上
SALES：実売上
VOID：取消
RETURN：返品
処理を行った日時を返却します。
3 ProcessDate - CHAR 14 処理日時
AUTH：仮売上
4 JobCd - CHAR 10 処理区分
SALES：実売上
VOID：取消
RETURN：返品
5 AccessID - CHAR 32 取引ID 参照した取引に設定されている値を返却します。
6 AccessPass - CHAR 32 取引パスワード参照した取引に設定されている値を返却します。
7 ItemCode - CHAR 7 商品コード参照した取引に設定されている値を返却します。
8 Amount - NUMBER 7 利用金額参照した取引に設定されている値を返却します。
9 Tax - NUMBER 7 税送料参照した取引に設定されている値を返却します。
10 SiteID - CHAR 13 サイトID 参照した取引に設定されている値を返却します。
11 MemberID - CHAR 60 会員ID 参照した取引に設定されている値を返却します。
12 CardNoToken - CHAR 16 カード番号トークントークン化されたカード番号を返却します。
13 Expire - CHAR 4 有効期限参照した取引に設定されている値を返却します。
1：一括
2：分割
14 Method - CHAR 1 支払方法
3：ボーナス一括
4：ボーナス分割
5：リボ
15 PayTimes - NUMBER 2 支払回数参照した取引に設定されている値を返却します。
16 Forward - CHAR 7 仕向先コード参照した取引に設定されている値を返却します。
17 TranID - CHAR 28 トランザクションID 参照した取引に設定されている値を返却します。
18 Approve - CHAR 7 承認番号参照した取引に設定されている値を返却します。

出力パラメータ(加盟店様⇒本サービス)
以下の値を出力してください。
受信した加盟店様では、受信した応答を返却してください。詳細な仕様は後述されます。また、加盟店様では特に不要
な通知でも、正常として応答してください。正常応答されない場合、再送対象となります。
必
須
応答ステータス
1 RecvRes - CHAR 1 受信結果
“0”：正常

BT11 プロトコルタイプ (カード決済 ブランドトークンインタフェース仕様)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

BT11 プロトコルタイプ (カード決済 ブランドトークンインタフェース仕様)

Uploaded by

Copyright:

Available Formats

ＰＧマルチペイメントサービス

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -1 -

1.1. 提供される機能 ......................................................................................................................................... 5

1.2. 開発するにあたっての注意事項 ................................................................................................................... 7

1.2.1. 取引について ..................................................................................................................................... 7

1.2.2. トークンについて ............................................................................................................................... 7

1.2.3. トークンの登録について ..................................................................................................................... 7

1.2.4. 本サービスのタイムアウトについて ...................................................................................................... 8

2.1. 全インタフェースに共通する仕様 ................................................................................................................ 9

2.2. ApplePay(ブランドトークン)決済を行う ..................................................................................................... 10

2.2.1. ApplePay(ブランドトークン)決済の流れ ............................................................................................. 10

2.2.2. 各インタフェース仕様詳細 ................................................................................................................ 11

2.3. オーソリを取り消す ................................................................................................................................. 15

2.3.1. オーソリを取り消す流れ ................................................................................................................... 15

2.3.2. 各インタフェース仕様詳細 ................................................................................................................ 16

2.4. 売上の確定を行う .................................................................................................................................... 18

2.4.1. 実売上を行う流れ ............................................................................................................................. 18

2.4.2. 各インタフェース仕様詳細 ................................................................................................................ 19

2.5.1. 返品を行う流れ ................................................................................................................................ 21

2.5.2. 各インタフェース仕様詳細 ................................................................................................................ 22

2.6. 金額の変更を行う .................................................................................................................................... 24

2.6.1. 金額変更を行う流れ .......................................................................................................................... 24

2.6.2. 各インタフェース仕様詳細 ................................................................................................................ 25

2.7. ApplePay(ブランドトークン)情報を登録する .............................................................................................. 27

2.7.1. ApplePay(ブランドトークン)登録の流れ ............................................................................................. 27

2.7.2. 各インタフェース仕様詳細 ................................................................................................................ 28

2.8. ApplePay(ブランドトークン)情報の削除をする ........................................................................................... 30

2.8.1. ApplePay(ブランドトークン)削除の流れ ............................................................................................. 30

2.8.2. 各インタフェース仕様詳細 ................................................................................................................ 31

2.9. ApplePay(ブランドトークン)情報を参照する .............................................................................................. 32

2.9.1. ApplePay(ブランドトークン)参照の流れ ............................................................................................. 32

2.9.2. 各インタフェース仕様詳細 ................................................................................................................ 33

2.10. 決済結果を参照する ............................................................................................................................. 35

2.10.1. 取引状態参照の流れ .......................................................................................................................... 35

2.10.2. 各インタフェース仕様詳細 ................................................................................................................ 36

2.11. 決済結果の通知を受け取る .................................................................................................................... 38

2.11.1. 各インタフェース仕様詳細 ................................................................................................................ 38

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -3 -

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -4 -

1 ApplePay(ブランドトーク 取引登録API【EntryTranBrandtoken】 ＋ 決済実行API【ExecTranBrandtoken】

10 決済結果の通知を受け取る 結果通知 (HTTPsによる、マルチペイメントから加盟店様へのPush通知)

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -5 -

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -6 -

仮売上のオーソリ実施後 90 日を越えて売上の確定を行うとエラーとなります。運用上 90 日を越える事が想定される場

1 会員につき、5 枚まで登録可能です。6 枚以上登録する場合には、登録済みのトークンを削除する必要があります。

論理連番は、常に 0 から始まる番号です。登録済みトークンを削除した場合、再計算され 0 から振り直されます。

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -7 -

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -8 -

Copyright (C) GMO Payment Gateway, Inc. All Rights Reserved. -9 -

各パラメータ値を POST で送信します。

2 ShopID ◎ CHAR 13 ショップID 弊社が発行する値を設定します。

3 ShopPass ◎ CHAR 8 ショップパスワード 弊社が発行する値を設定します。

5 JobCd ◎ CHAR - 処理区分 CAPTURE：即時売上

6 ItemCode CHAR 7 商品コード(※1) 略時は"0000990"を適用します。

7 Amount ◎ NUMBER 7 利用金額 指定します。

1 AccessID - CHAR 32 取引ID ※同一オーダーIDでも決済手段が異なると、

2 AccessPass - CHAR 32 取引パスワード ※同一オーダーIDでも決済手段が異なると、

各パラメータ値を POST で送信します。

2 ShopID ◎ CHAR 13 ショップID 【取引登録】で指定した値を設定します。

3 ShopPass ◎ CHAR 8 ショップパスワード 【取引登録】で指定した値を設定します。

4 AccessID ◎ CHAR 32 取引ID 【取引登録】で発行された値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード 【取引登録】で発行された値を設定します。

6 OrderID ◎ CHAR 27 オーダーID 【取引登録】で指定した値を設定します。

BT11 プロトコルタイプ (カード決済ブランドトークンインタフェース仕様)

BT11 プロトコルタイプ (カード決済ブランドトークンインタフェース仕様)

1 ApplePay(ブランドトーク取引登録API【EntryTranBrandtoken】＋決済実行API【ExecTranBrandtoken】

10 決済結果の通知を受け取る結果通知 (HTTPsによる、マルチペイメントから加盟店様へのPush通知)

3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

7 Amount ◎ NUMBER 7 利用金額指定します。

3 ShopPass ◎ CHAR 8 ショップパスワード【取引登録】で指定した値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。

7 TokenType ● CHAR 8 トークン種別現在、以下のコードに対応しています。

10 SitePass ● CHAR 10 サイトパスワード弊社が発行する値を設定します。

10 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)と

11 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)と

3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。

2 AccessPass - CHAR 32 取引パスワード【決済取消】呼出時に指定した値を返却します。

8 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)とな

9 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)とな

3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。

7 Amount ◎ NUMBER 7 確定金額オーソリ金額から増額／減額した確定はでき

8 Tax NUMBER 7 確定税送料オーソリ金額から増額／減額した確定はでき

2 AccessPass - CHAR 32 取引パスワード【実売上】呼出時に指定した値を返却します。

8 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)と

9 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)と

3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。

7 Amount ◎ NUMBER 7 返品金額確定時から減額／増額した返品はできませ

8 Tax NUMBER 7 返品税送料確定時から減額／増額した返品はできませ

2 AccessPass - CHAR 32 取引パスワード【返品】呼出時に指定した値を返却します。

8 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)と

9 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)と

3 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

5 AccessPass ◎ CHAR 32 取引パスワード【取引登録】で発行された値を設定します。

8 Amount ◎ NUMBER 7 利用金額変更後の利用金額を設定します。

2 AccessPass - CHAR 32 取引パスワード【金額変更】呼出時に指定した値を返却します。

8 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)とな

9 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)とな

3 SitePass ◎ CHAR 10 サイトパスワード弊社が発行する値を設定します。

6 ShopPass ◎ CHAR 8 ショップパスワード弊社が発行する値を設定します。

9 SeqMode ● CHAR 10 連番モード場合に、トークンを指し示す番号になります。

2 CardNoToken - CHAR 16 カード番号トークン登録されたトークン番号を返却します。

4 ErrCode - CHAR 3 エラーコード複数ある場合は"|"で接続された文字列(※1)と

5 ErrInfo - CHAR 9 エラー詳細コード複数ある場合は"|"で接続された文字列(※1)と