VeriTrans4G BankPay ご利用ガイド

VeriTrans4G 開発ガイド別冊
BankPay ご利用ガイド
Ver. 1.0.3 版 （2024 年 05 月～）

Copyright © 2024 DG Financial Technology, Inc., a Digital Garage company. All rights reserved.

1VeriTrans4G BankPay ご利用ガイド

目次
第1章

本ガイドの内容 ................................................................................................................................................ 4

本ガイドの内容 ...................................................................................................................................................................... 4
著作権、および問い合わせ先 ................................................................................................................................................. 4
改訂履歴 ............................................................................................................................................................................... 4

第2章

BankPay サービス概要 ................................................................................................................................... 5

BankPay サービスの概要 ...................................................................................................................................................... 5
課金種別（都度決済、随時決済、チャージ） ............................................................................................................................. 6

第3章

MDK の処理概要 ............................................................................................................................................ 7

機能一覧（決済要求コマンド） ................................................................................................................................................. 7
決済処理シーケンス............................................................................................................................................................... 8

第4章

結果通知受信処理 ......................................................................................................................................... 14

結果通知受信処理の対象 .................................................................................................................................................... 14

第5章

インターフェイス詳細 ...................................................................................................................................... 15

BankPay ............................................................................................................................................................................. 15
5.1.1 決済申込 ............................................................................................................................................................................................ 15
5.1.2 返金 ................................................................................................................................................................................................... 17
5.1.3 会員登録 ............................................................................................................................................................................................ 19
5.1.4 会員情報更新 ..................................................................................................................................................................................... 21
5.1.5 会員削除 ............................................................................................................................................................................................ 23
5.1.6 口座入力情報取得 .............................................................................................................................................................................. 24
5.1.7 口座登録 ............................................................................................................................................................................................ 26
5.1.8 消費者ブラウザから店舗側の確認画面へリダイレクトする時のパラメータ ............................................................................................... 27
5.1.9 口座削除 ............................................................................................................................................................................................ 29
5.1.10 口座照会 .......................................................................................................................................................................................... 30

共通 .................................................................................................................................................................................... 31
5.2.1 検索 ................................................................................................................................................................................................... 31

結果通知電文...................................................................................................................................................................... 36
5.3.1 結果通知電文の概要 .......................................................................................................................................................................... 36
5.3.2 BankPay の結果通知電文 .................................................................................................................................................................. 36

第6章

ご利用上の注意事項...................................................................................................................................... 38

会員登録での遷移について.................................................................................................................................................. 38
6.1.1 銀行選択画面 ..................................................................................................................................................................................... 38
6.1.2 口座情報入力画面 .............................................................................................................................................................................. 38
6.1.3 BankPay への遷移処理 ...................................................................................................................................................................... 38

会員・口座の登録について ................................................................................................................................................... 40
6.2.1 同一口座の登録について .................................................................................................................................................................... 40
6.2.2 登録可能な口座数の上限について ...................................................................................................................................................... 40

返金可能期間について ........................................................................................................................................................ 40

第7章

その他 補足事項 .......................................................................................................................................... 412

VeriTrans4G BankPay ご利用ガイド
検索（Search）に関する補足（詳細コマンドタイプ/詳細オーダー決済状態） ............................................................................. 41
使用可能文字...................................................................................................................................................................... 41

第8章

導入・テストに関する補足 ............................................................................................................................... 43

口座登録時の画面遷移をシミュレートする............................................................................................................................. 43
Authorie, Refund コマンドのエラーをシミュレートする ........................................................................................................... 44
会員系コマンドのエラーをシミュレートする ............................................................................................................................. 44
口座系コマンドのエラーをシミュレートする ............................................................................................................................. 45
ダミー取引で登録した会員・口座情報のデータ保持期間について .......................................................................................... 45

3

VeriTrans4G BankPay ご利用ガイド

第1章本ガイドの内容
本ガイドの内容
本ガイドは、株式会社 DG フィナンシャルテクノロジーが提供する VeriTrans4G の BankPay サービス(※1)をインターネット店舗等に導入するための、開発者向けのガイドです。
VeriTrans4G の開発ガイドとの統合を行うまでの間、別冊でのご提供となります。

※1） Pay-easy（ペイジー）とは別の決済サービスとなりますので、間違えのないようご注意ください。

著作権、および問い合わせ先[著作権]
本ドキュメントの著作権は株式会社 DG フィナンシャルテクノロジーが保有しています。
Copyright © 2024 DG Financial Technology, Inc., a Digital Garage company. All rights reserved.
[お問い合わせ先]株式会社 DG フィナンシャルテクノロジー ベリトランス テクニカルサポート
電子メール：

tech-support@veritrans.jp

改訂履歴2022/12 ：Ver. 1.0.0 リリース
2023/03 ：Ver. 1.0.1 リリース
「2-2 課金種別（都度決済、随時決済、チャージ）」の「チャージ」の説明を更新「5.1.7 口座登録」の応答電文の「bankPayAccountsRegisterUrl」を「bankpayAccountsRegisterUrl」に修正「5.1.10 口座照会」の応答電文の「maskedAccountName」の説明を更新「5.2.1 検索」の要求電文に「memberId」、「accountId」を追加「6.1.3 BankPay への遷移処理」の電文仕様の遷移先 URL の仕様の記載で「bankPayAccountsRegisterUrl」を「bankpayAccountsRegisterUrl」に修正「8-2 Authorize, Refund コマンドのエラーをシミュレートする」の vResultCode で B004 の記載を削除「8-4 口座系コマンドのエラーをシミュレートする」の口座照会に注釈を追加
2023/09 ：Ver. 1.0.2 リリース
「3-2 決済処理シーケンス」【口座登録処理】 結果通知受信を強調「5.1.8 消費者ブラウザから店舗側の確認画面へリダイレクトする時のクエリパラメータ」
章タイトルを「5.1.8 消費者ブラウザから店舗側の確認画面へリダイレクトする時のパラメータ」に変更
結果通知に関する注意書きを追加「クエリパラメータ」を「パラメータ」に変更「この改ざんチェックは必須ではありませんが」の「必須ではありませんが」を削除
2024/05 ：Ver. 1.0.3 リリース
「5.1.6 口座入力情報取得」の応答電文、「5.1.8 消費者ブラウザから店舗側の確認画面へのリダイレクトする時のパラメータ」、「5.1.10 口座照会」の応答電文、「5.3.2 BankPay の結果通知電文」、「6.1.13 BankPay への遷移処理」の「depositType」の説明を更新「8-4 口座系コマンドのエラーをシミュレートする」の説明を修正

4

VeriTrans4G BankPay ご利用ガイド

第2章BankPay サービス概要
BankPay サービスの概要
BankPay サービスは、事前に銀行の口座情報を登録し、登録した口座情報を用いて決済を行うサービスです。



口座情報の登録は、銀行毎のページにリダイレクトして実施します。



口座情報を登録することで、決済の度に口座情報を入力する必要がなくなります。



口座登録なしで決済のみの実施はできません。

図 2.1 口座登録の画面遷移のイメージ

図 2.2 決済時の画面遷移のイメージ

5

VeriTrans4G BankPay ご利用ガイド

課金種別（都度決済、随時決済、チャージ）
BankPay サービスにおいて、課金種別は「都度決済」・「随時決済」・「チャージ」で区別されます。

【共通】①

事前に会員登録, 口座登録を実施しておき、決済は加盟店からリクエストする必要があります※随時決済の場合でも自動で決済は行われず、加盟店からリクエストする必要があります。

②

登録した会員・口座情報はすべての課金種別で利用可能です。

③

一度登録した会員・口座情報は、基本的に削除するまでは繰り返し決済にご利用いただけます。

【都度決済機能】
加盟店が提供する商品もしくはサービスを購入する毎に、口座引落を行う決済が該当します。

【随時決済機能】
加盟店と消費者が事前に取り決めた条件(金額や日時等)にのっとり、利用者による購入手続きなく口座引き落としを行う決済が該当します。

【チャージ】
BankPay では、チャージの類型を前払式支払手段（ハウス）／前払式支払手段（オープン）／資金移動の３つとし、定義は以下の通りとなっています。
（前払式支払手段と資金移動の区分は資金決済に関する法律の例によります）
１． チャージ(ハウス)：①

バリュー提供者自身またはバリュー提供者自身と資本関係のあるグループ会社のサービス対価としてのみ利用可
能なバリューチャージ②

バリュー提供者と提携する特定一社または当該特定一社と資本関係のあるグループ会社のサービス対価としてのみ利用可能なバリューチャージ（例：電子マネーの発行者＝バリュー提供者）
２． チャージ(オープン)：
チャージ（ハウス）に該当しない前払式支払手段の取引（例：バリュー提供者と提携する複数の提携先のサービス対価として利用可能なバリューへのチャージ取引）
３． チャージ(資金移動)：
資金移動者へのチャージであり、チャージしたバリューは提携先のすべての加盟店で利用可能かつ現金として引き出したり、別のサービスの会員に送金することが可能。

6

VeriTrans4G BankPay ご利用ガイド

第3章 MDK の処理概要
機能一覧（決済要求コマンド）
使用可能な決済要求コマンドを下記表に示します。
決済要求種類/コマンド
決済申込 （与信＋売上）/Authorize
返金/Refund概要
決済の申し込みと売上を同時に要求します。
事前に会員および銀行口座情報の登録が必要になります。
売上済の取引に対し、返金を要求します。
※全額返金のみ可能

会員登録/MemberAdd

会員の登録を要求します。

会員情報更新/MemberUpdate

会員情報の更新を要求します。

会員削除/MemberDelete

会員の削除を要求します。
口座情報入力画面を表示するために必要な情報を取得します。

口座入力情報取得/PrepareAccountAdd

口座登録の遷移については「3-2 決済処理シーケンス」の【口座登録処理】および「6-1 会員登録での遷移について」を参照してください。

口座登録/AccountAdd口座の登録を行うための画面に遷移するために必要な情報を取得します。

口座削除/AccountDelete

口座の削除を要求します。

口座照会/AccountGet

口座情報の照会を要求します。
表 3.1 使用可能なコマンド一覧

表 3.2 各コマンドの実施可能タイミング

7

VeriTrans4G BankPay ご利用ガイド

決済処理シーケンス【決済申込処理】

図 3.1 MDK 利用時システム処理概要図（BankPay 決済申込要求）

No.

基本機能

処理説明

1

決済申込要求決済申込の対象となる取引情報を電文化し、決済サーバーに送信します。

2

決済申込応答決済サーバーより結果応答を受信します。

【返金処理】

図 3.2 MDK 利用時システム処理概要図（BankPay 返金要求）

No.

基本機能

処理説明

1

返金要求

返金の対象となる取引情報を電文化し、決済サーバーに送信します。

2

返金応答

決済サーバーより結果応答を受信します。

8

VeriTrans4G BankPay ご利用ガイド【会員登録処理】

図 3.3 MDK 利用時システム処理概要図（BankPay 会員登録要求）

No.

基本機能

処理説明

1

会員登録要求会員登録に必要な情報を電文化し、決済サーバーに送信します。

2

会員登録応答決済サーバーより結果応答を受信します。

【会員情報更新処理】

図 3.4 MDK 利用時システム処理概要図（BankPay 会員情報更新要求）

No.

基本機能

処理説明

1

会員情報更新要求

会員情報更新に必要な情報を電文化し、決済サーバーに送信します。

2

会員情報更新応答

決済サーバーより結果応答を受信します。

9VeriTrans4G BankPay ご利用ガイド【会員削除処理】

図 3.5 MDK 利用時システム処理概要図（BankPay 会員削除要求）

No.

基本機能

処理説明

1

会員削除要求会員削除に必要な情報を電文化し、決済サーバーに送信します。

2

会員削除応答決済サーバーより結果応答を受信します。

10VeriTrans4G BankPay ご利用ガイド【口座登録処理】

図 3.6 MDK 利用時システム処理概要図（BankPay 口座登録）

No.

基本機能

処理説明

1

銀行選択画面の表示

口座登録を行う銀行を選択する画面を加盟店が作成します。

2

口座入力情報取得要求

口座情報入力取得に必要な情報を電文化し、決済サーバーに送信します。

3

結果応答

決済サーバーからの応答から口座情報入力画面に必要な項目を確認し、口座情報入力画面
を作成します。

4

口座情報入力画面の表示

口座登録に必要な情報を入力するための画面を表示します。

5

口座登録要求口座登録に必要な情報を電文化し、決済サーバーに送信します。

6

結果応答

口座情報以外の口座登録に必要な情報を受信します。

7

リダイレクト指示

入力された口座情報と、口座登録に必要な情報を用いて、BankPay へ口座登録処理を開始するための要求を行います。
詳細は「6.1.3 BankPay への遷移処理」を参照してください。

11VeriTrans4G BankPay ご利用ガイド
8

口座登録処理結果通知

口座登録結果を受け取り、加盟店システムに反映します。
完了画面要求は、消費者の端末（PC やスマートフォン）のネットワーク環境の問題や、誤操作（ブラウザやタブを閉じてしまう等）により、正しく行われない可能性がありますので、必ずこの通知を受信してください。
なお、結果通知と完了画面要求のリダイレクト結果が加盟店に届く順番は保証されていません。どちらが先に届いても問題とならないようにご対応ください。

9

完了画面要求決済サーバーから応答された BankPay の口座登録結果を加盟店の画面などに表示し、消費者に結果をお伝えください。

【口座削除処理】

図 3.7 MDK 利用時システム処理概要図（BankPay 口座削除要求）

No.

基本機能

処理説明

1

口座削除要求口座削除に必要な情報を電文化し、決済サーバーに送信します。

2

口座削除応答決済サーバーより結果応答を受信します。

【口座照会処理】

図 3.8 MDK 利用時システム処理概要図（BankPay 口座照会要求）

12VeriTrans4G BankPay ご利用ガイド
No.

基本機能

処理説明

1

口座照会要求口座照会に必要な情報を電文化し、決済サーバーに送信します。

2

口座照会応答決済サーバーより結果応答を受信します。

13

VeriTrans4G BankPay ご利用ガイド

第4章 結果通知受信処理
結果通知受信処理の対象
BankPay の結果通知受信処理の対象は以下の機能です。
コマンド名

送信有無

決済申込

－

返金

－

会員登録

－

会員情報更新

－

会員削除

－

口座登録

○

口座削除

－

口座照会

－ (※1)

表 4.1 通知対象一覧※1) 口座照会の対象の会員 ID において、登録中の口座が存在していた場合は登録結果を確認し、登録結果が確定した場合は口座登録と同様に結果通知を送信します。

通信電文仕様（共通部）および店舗様受信後応答仕様は、『開発ガイド』をご参照ください。
BankPay 固有の通知電文インターフェイスにつきましては、「5-3 結果通知電文」の「5.3.2 BankPay の結果通知電文」をご参照ください。

14

VeriTrans4G BankPay ご利用ガイド

第5章 インターフェイス詳細
ここでは BankPay サービスで利用する MDK インターフェイス項目を説明します。

■「設定」欄の内容は以下の通りです。
要求電文 … 必須項目：○

任意項目：△

設定不可：×

応答電文 … 必ず返戻：○

返戻しないケースあり：△

その他条件付：※、※n（条件は説明欄、または欄外に記入）

返戻なし：×

その他条件付：※■orderId（取引 ID）について
店舗様で任意に採番してください。申込、再与信処理毎に付ける必要があります。他の取引 ID と重複しないよう採番してください。他決済サービスとも重複できません。
また、テスト取引で使用した取引 ID を、本番取引で再度使用することはできません。
取引 ID には、半角英数字以外に"-"（ハイフン）、"_"（アンダースコア）も使用可能です。
■応答電文について
応答電文には、本書に記載されていないフィールド（パラメータ）も存在しますが、通常は、記載されているフィールド以外は加盟店の方で意識する必要はございません。

BankPay
5.1.1 決済申込
要求電文 ： BankPayAuthorizeRequestDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
100 桁以内
半角数字
7 桁以内
半角英数字
100 桁以内
半角英数字
100 桁以内

店舗側で採番した取引 ID を指定
上記「orderId（取引 ID）について」参照○

決済金額を指定- 1 以上かつ 9999999(7 桁) 以下
会員登録を行った店舗側で会員を一意に表す会員 ID を指定します。
会員 ID に紐づく口座 ID を指定します。

○

課金種別

右記参照

○

端末機識別番号

半角数字
13 桁"0"：都度決済"1"：随時決済"2"：チャージ（オープン）"3"：チャージ（ハウス）"4"：チャージ（資金移動）
店舗 POS などの決済端末を識別する値を指定
チャージのみの利用の場合は、一意な値を設定して問題ご
ざいません。

orderId

取引 ID

amount

決済金額

memberId

会員 ID

accountId

口座 ID

accountingTypeterminalId○○○

流通決済事業者コードを設定可能な場合は先頭 5 桁に設定することをお勧めします。
流通事業者コード：
https://www.dsri.jp/code/credit/
storeId

店舗 ID

半角英数字
5桁

任意の店舗 ID を指定△

15

VeriTrans4G BankPay ご利用ガイド

要求電文 ： BankPayAuthorizeRequestDto
フィールド名storeName

項目名
店舗名

書式・制限
文字列
50 桁以内説明
利用者アプリ表示用の店舗名使用可能文字については「7-2 使用可能文字」を参照して
ください。

設
定

△

応答電文 ： BankPayAuthorizeResponseDto
フィールド名

項目名

書式・制限

説明

設
定

serviceType

決済サービスタイプ

半角英数字
10 桁以内要求電文を送信した決済サービスタイプ○

mstatus

処理結果コード

半角英数字
32 文字以内"success"：正常終了"failure"：異常終了"pending"：保留○vResultCode

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

marchTxn

電文 ID

文字列
1024 byte 以内
文字列
100 桁以内

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

orderId

取引 ID

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。
決済要求時に店舗様にて任意に採番し送信された取引 ID

custTxn

取引毎に付く ID

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する
ID○

txnVersion

MDK バージョン

半角英数字
5桁

○

merchantTransactionId

加盟店処理通番

半角英数字
100 桁以内

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
BankPay で取引を一意に識別する ID

centerTransactionId

決済センター側の
処理通番

半角英数字
36 桁

BankPay にて採番する処理通番△

bankApprovalNum

承認番号

半角英数字
7 桁以内

金融機関にて採番する承認番号△

bankProcessingId

決済処理通番

金融機関にて採番する決済処理通番△

centerProcessingDatetime

決済センター処理
日時

半角英数字
7桁
半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）

△

半角英数字
100 桁以内
文字列
100 桁以内

○

○

△

16

VeriTrans4G BankPay ご利用ガイド

5.1.2 返金要求電文 ： BankPayRefundRequestDto
フィールド名

項目名

orderId

取引 ID

amount

返金金額

terminalId

端末機識別番号

書式・制限

説明

設
定

半角英数字
100 桁以内
半角数字
7 桁以内

決済申込で指定した値を設定します。

○

返金金額を指定。
※全額返金のみ可能。
※未指定時は、返金可能金額全額。

△

半角数字
13 桁

店舗 POS などの決済端末を識別する値を指定
チャージのみの利用の場合は、一意な値を設定して問題ござ
いません。

△

流通決済事業者コードを設定可能な場合は先頭 5 桁に設定することをお勧めします。
流通事業者コード：
https://www.dsri.jp/code/credit/

storeId

店舗 ID

storeName

店舗名

半角英数字
5桁
文字列
50 桁以内※未指定時は決済申込で指定した値を使用
任意の店舗 ID を指定
利用者アプリ表示用の店舗名使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△
△

応答電文 ： BankPayRefundResponseDto
フィールド名

項目名

書式・制限

説明

設
定

serviceType

決済サービスタイプ

半角英数字
10 桁以内要求電文を送信した決済サービスタイプ○

mstatus

処理結果コード

半角英数字
32 文字以内"success"：正常終了"failure"：異常終了"pending"：保留○vResultCode

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

marchTxn

電文 ID

文字列
1024 byte 以内
文字列
100 桁以内

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

orderId

取引 ID

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。
決済要求時に店舗様にて任意に採番し送信された取引 ID

custTxn

取引毎に付く ID○

txnVersion

MDK バージョン

memberId

会員 ID

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する
ID
電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
決済申込時に指定した会員 ID

accountId

口座 ID

決済申込時に指定した口座 ID△

accountingType

課金種別

決済申込時に指定した課金種別

△

半角英数字
100 桁以内
文字列
100 桁以内
半角英数字
5桁
半角英数字
100 桁以内
半角英数字
100 桁以内
右記参照

○

○

○

△

17

VeriTrans4G BankPay ご利用ガイド
terminalId

端末機識別番号

半角数字
13 桁

要求電文で指定した端末識別番号△

merchantTransactionId

加盟店処理通番

半角英数字
100 桁以内

BankPay で取引を一意に識別する ID△

centerTransactionId

決済センター側の
処理通番

半角英数字
36 桁

BankPay にて採番する処理通番△

bankApprovalNum

承認番号

金融機関にて採番する承認番号△

bankProcessingId

決済処理通番

金融機関にて採番する決済処理通番△

centerProcessingDatetime

決済センター処理
日時

半角英数字
7 桁以内
半角英数字
7桁
半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）△18

VeriTrans4G BankPay ご利用ガイド

5.1.3 会員登録
要求電文 ： BankPayMemberAddRequestDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
100 桁以内
半角英数字
32 桁

加盟店側で会員を一意に表す顧客 ID を指定します。
“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
利用者の端末を識別する ID を指定します。
スマホなどのデバイスを識別するための UUID などの情報を指定してください。EC 利用などの場合は一意なランダムな値を指定してください。

○

氏名

文字列
20 桁以内会員の氏名を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

userNameKana

カナ氏名

文字列
40 桁以内会員のカナ名を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

birthDate

生年月日

半角数字
8桁

△

gender

性別

半角英字
1桁

zipcode郵便番号

address

住所

半角数字記号
8 桁以内
文字列
60 桁以内telNumber

電話番号

mobileNumber

携帯番号

会員の生年月日を入力します。
書式は YYYYMMDD。
例)20220531
会員の性別を入力します。
-"M":男-"F":女会員の郵便番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。
会員の住所を入力します。
使用可能文字については「7-2 使用可能文字」を参照してください。
会員の電話番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。
会員の携帯番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。

emailAddress

メールアドレス

半角英数字記号
300 桁以内

会員のメールアドレスを入力します。

△

emailAddress2

メールアドレス 2

半角英数字記号
300 桁以内

会員のメールアドレスが 2 つある場合 2 つ目を入力します。

△

remarks

摘要

文字列
100 桁以内

会員についての備考項目を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

memberId

会員 ID

userTerminalId

利用者端末識別 ID

userName

半角数字記号
16 桁以内半角数字記号
16 桁以内

○

△

△
△

△
△

応答電文 ： BankPayMemberAddResponseDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
10 桁以内
半角英数字
32 文字以内
半角英数字
16 文字

要求電文を送信した決済サービスタイプ○"success"：正常終了"failure"：異常終了
処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。

○

エラーメッセージ

文字列1024 byte 以内

処理結果を日本語で表示○

MDK バージョン

半角英数字
5桁

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○

serviceType

決済サービスタイプ

mstatus

処理結果コードvResultCode

詳細結果コード

merrMsg
txnVersion○

19

VeriTrans4G BankPay ご利用ガイド
processId

処理通番

半角英数字
100 桁以内

決済サーバーにて採番する処理通番。

△

memberId

会員 ID

半角英数字
100 桁以内

リクエストされた値△

merchantUserId

顧客 ID

半角英数字
60 桁以内BankPay で会員を一意に識別する ID△

centerTransactionId

決済センター側の処理通番
決済センター処理
日時

半角英数字
36 桁
半角数字
14 桁

BankPay にて採番する処理通番△

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）△

centerProcessingDatetime20VeriTrans4G BankPay ご利用ガイド

5.1.4 会員情報更新
要求電文 ： BankPayMemberUpdateRequestDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
100 桁以内
半角英数字
32 桁

会員登録で指定した値を設定します。

○

利用者の端末を識別する ID を指定します。
スマホなどのデバイスを識別するための UUID などの情報を指定してください。EC 利用などの場合は一意なランダムな値を指定してください。

△

氏名

文字列
20 桁以内会員の氏名を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

userNameKana

カナ氏名

文字列
40 桁以内会員のカナ名を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

birthDate

生年月日

半角数字
8桁

△

gender

性別

半角英字
1桁

zipcode郵便番号

address

住所

半角数字記号
8 桁以内
文字列
60 桁以内telNumber

電話番号

mobileNumber

携帯番号

会員の生年月日を入力します。
書式は YYYYMMDD。
例)20220531
会員の性別を入力します。
"M" ：男"F" ：女会員の郵便番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。
会員の住所を入力します。
使用可能文字については「7-2 使用可能文字」を参照してください。
会員の電話番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。
会員の携帯番号を入力します。
“-”（ハイフン）有でも無でも指定可能です。

emailAddress

メールアドレス

半角英数字記号
300 桁以内

会員のメールアドレスを入力します。

△

emailAddress2

メールアドレス 2

半角英数字記号
300 桁以内

会員のメールアドレスが 2 つある場合 2 つ目を入力します。

△

remarks

摘要

文字列
100 桁以内

会員についての備考項目を入力します。
使用可能文字については「7-2 使用可能文字」を参照してく
ださい。

△

memberId

会員 ID

userTerminalId

利用者端末識別 ID

userName

半角数字記号
16 桁以内半角数字記号
16 桁以内

△

△
△

△
△

応答電文 ： BankPayMemberUpdateResponseDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
10 桁以内
半角英数字
32 文字以内
半角英数字
16 文字

要求電文を送信した決済サービスタイプ○"success"：正常終了"failure"：異常終了
処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。

○

エラーメッセージ

文字列1024 byte 以内

処理結果を日本語で表示○

MDK バージョン

半角英数字
5桁

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○

serviceType

決済サービスタイプ

mstatus

処理結果コードvResultCode

詳細結果コード

merrMsg
txnVersion○

21

VeriTrans4G BankPay ご利用ガイド
processId

処理通番

半角英数字
100 桁以内

決済サーバーにて採番する処理通番。

△

memberId

会員 ID

半角英数字
100 桁以内

リクエストされた値△

centerTransactionId

決済センター側の
処理通番

半角英数字
36 桁

BankPay にて採番する処理通番△

centerProcessingDatetime

決済センター処理
日時

半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）△

22

VeriTrans4G BankPay ご利用ガイド

5.1.5 会員削除
要求電文 ： BankPayMemberDeleteRequestDto
フィールド名memberId

項目名
会員 ID

書式・制限
半角英数字
100 桁以内

説明
会員登録で指定した値を設定します。

設
定○応答電文 ： BankPayMemberDeleteResponseDto
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
10 桁以内
半角英数字
32 文字以内

要求電文を送信した決済サービスタイプ○"success"：正常終了"failure"：異常終了○

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

txnVersion

MDK バージョン

文字列1024 byte 以内
半角英数字
5桁

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

processId

処理通番

memberId

会員 ID

リクエストされた値△

centerTransactionId

決済センター側の
処理通番

半角英数字
100 桁以内
半角英数字
100 桁以内
半角英数字
36 桁

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
決済サーバーにて採番する処理通番。

BankPay にて採番する処理通番△

centerProcessingDatetime

決済センター処理
日時

半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）△

serviceType

決済サービスタイプ

mstatus

処理結果コードvResultCode

○

△

23

VeriTrans4G BankPay ご利用ガイド

5.1.6 口座入力情報取得
要求電文 ： BankPayPrepareAccountAddRequestDto
フィールド名

項目名

memberId

会員 ID

accountId

口座 ID

bankCode

銀行コード

successUrl

決済完了時 URL

errorUrl

pushUrl

決済エラー時 URL

プッシュ先 URL

書式・制限
半角英数字
100 桁以内
半角英数字
100 桁以内
半角数字
4桁
URL に使用可能な
半角文字
256 桁以内URL に使用可能な
半角文字
256 桁以内URL に使用可能な
半角文字
256 桁以内

説明設定

会員登録で指定した値を設定します。

○

会員ＩＤに対して口座を一意に表す口座 ID を指定します。
“-”（ハイフン）、“_”（アンダースコア）も使用可能です。
登録口座の銀行コードを入力します。

○

口座登録完了後に、店舗側サイトに画面遷移を戻すための
URL を指定します。

△※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
※MAP で未登録かつ本パラメータ未設定の場合はエラーを返戻します。
口座登録エラー時に、店舗側サイトに画面遷移を戻すための
URL を指定します。

○△※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。
※MAP で未登録かつ本パラメータ未設定の場合はエラーを返戻します。

△

プッシュ URL を指定します。
※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

応答電文 ： BankPayPrepareAccountAddResponseDto
フィールド名

項目名

書式・制限

説明

設
定

serviceType

決済サービスタイプ

半角英数字
10 桁以内要求電文を送信した決済サービスタイプ○

mstatus

処理結果コード

半角英数字
32 文字以内"success"：正常終了"failure"：異常終了○

vResultCode

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

txnVersion

MDK バージョン

文字列1024 byte 以内
半角英数字
5桁

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

processId

処理通番

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
決済サーバーにて採番する処理通番。

memberId

会員 ID

要求電文に設定した値△

accountId

口座ＩＤ

半角英数字
100 桁以内

要求電文に設定した値△

branchCodeFlag

支店コード入力要
否

半角英字
5 桁以内

口座の支店コード入力要否を返却します。
"true"：入力が必要"false"：入力が不要△

depositTypeFlag

預金種目入力要否

半角英字

口座の預金種目入力要否を返却します。

△

半角英数字
100 桁以内
半角英数字
100 桁以内○△24

VeriTrans4G BankPay ご利用ガイド
5 桁以内
accountNumFlag

口座番号入力要否

半角英字
5 桁以内

accountNameFlag

口座名義人名入力
要否

半角英字
5 桁以内

centerTransactionId

決済センター側の処理通番
決済センター処理
日時

半角英数字
36 桁
半角数字
14 桁

centerProcessingDatetime"true"：入力が必要"false"：入力が不要
口座の口座番号入力要否を返却します。
"true"：入力が必要"false"：入力が不要
口座の口座名義人名入力要否を返却します。
"true"：入力が必要"false"：入力が不要
BankPay にて採番する処理通番△

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）

△

△

△

25

VeriTrans4G BankPay ご利用ガイド

5.1.7 口座登録
口座登録処理を完了させるためには、口座登録コマンド実施後に BankPay への遷移が必要になります。
詳細については、「6.1.3 BankPay への遷移処理」を参照してください。

要求電文 ： BankPayAccountAddRequestDto
フィールド名

項目名

memberId

会員 ID

accountId

口座 ID

書式・制限
半角英数字
100 桁以内
半角英数字
100 桁以内説明

設定

口座入力情報取得で指定した値を設定します。

○

口座入力情報取得で指定した値を設定します。

○

応答電文 ： BankPayAccountAddResponseDto
フィールド名

項目名

書式・制限

説明

設
定

serviceType

決済サービスタイプ

半角英数字
10 桁以内要求電文を送信した決済サービスタイプ○

mstatus

処理結果コード

半角英数字
32 文字以内"success"：正常終了"failure"：異常終了○

vResultCode

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

txnVersion

MDK バージョン

文字列1024 byte 以内
半角英数字
5桁

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

processId

処理通番

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
決済サーバーにて採番する処理通番。

preparedProcessId

口座入力情報取得の処理通番

口座入力情報取得時に決済サーバーにて採番された
processId。

△

memberId

会員 ID

半角英数字
100 桁以内

要求電文に設定した値△

accountId

口座ＩＤ

半角英数字
100 桁以内

要求電文に設定した値△

bankpayAccountsRegist
erUrl

BankPay 口座登録
URL

URL に使用可能な
半角文字
256 桁以内

BankPay への遷移に必要な項目。
BankPay に遷移するために使用してください。

△

accountLabel

口座ラベル

文字列
50 桁以内BankPay への遷移に必要な項目。

△

backUrl

戻り先 URLURL に使用可能な
半角文字
256 桁以内

BankPay への遷移に必要な項目。

△

customerAccessToken

会員用アクセストー
クン

半角英数字
32 桁

BankPay への遷移に必要な項目。

△

processorAuthentication
KeyIndexmac

Pay 事業者認証鍵
世代番号
メッセージ認証コー
ド

半角数字
2桁
半角英数字
44 桁

BankPay への遷移に必要な項目。

△

BankPay への遷移に必要な項目。

△

半角英数字
100 桁以内
半角英数字
100 桁以内○△26

VeriTrans4G BankPay ご利用ガイド

5.1.8 消費者ブラウザから店舗側の確認画面へリダイレクトする時のパラメータ
リダイレクト受信内容：決済サーバーから消費者ブラウザ経由で店舗側へリダイレクト(POST)される内容
フィールド名

項目名

書式・制限

説明

設
定

半角英数字
32 文字以内
半角英数字
16 文字

"success"：正常終了"failure"：異常終了
処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。

○

処理通番

半角英数字
100 桁以内

決済サーバーにて採番する処理通番。

△

memberId

会員 ID

要求電文に設定した値△

accountId

口座ＩＤ

要求電文に設定した値△

bankCode

銀行コード登録された銀行コードを返却します。

△

branchCode

支店コード

半角英数字
100 桁以内
半角英数字
100 桁以内
半角数字
4桁
半角数字
3桁

登録された支店コードを返却します。

△

depositType

預金種目

半角数字
1桁

登録された預金種目を返却します。
"1": 普通口座△

mstatus

処理結果コードvResultCode

詳細結果コード

processId○"2": 当座口座
maskedAccountNum

半角数字記号7桁登録された口座番号(マスクした値)を返却します。

△

文字列
30 文字以内登録された口座名義人名(マスクした値)を返却します。

△

文字列
32 文字以内

実行したコマンド名。

△

半角英数字
36 桁

BankPay にて採番する処理通番

△

半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）△

ハッシュ値算出パ
ラメータ順序文字列
右記参照

下記文字列を連結し、SHA-256 によって算出したハッシュ値
・マーチャント CCID
・パラメータ値の連結文字列（authParams が示す順序で連結）・パスワード尚、パラメータ値を連結する際は、パラメータ名や区切り文字
は含めず、パラメータ値のみを連結しています。連結した文字
列をバイナリに変換する際の文字エンコーディングは、UTF-8を使用しています。
vAuthInfo のハッシュ値を算出する元とした文字列の、パラメータの連結順序を示す値
パラメータ名のカンマ区切り文字列を Base64 エンコードしています。デコードを行うと文字列が復元されます。
例)"orderId,vResultCode,mstatus""mstatus,orderId,vResultCode"（順序は固定ではないため、リクエスト受信のたびに動的に処理する必要があります。）

〇

ハッシュ値

文字列
右記参照

マスクされた
口座番号

maskedAccountName

マスクされた口座名義人名txnType

トランザクションタイ
プ

centerTransactionId

決済センター側の処理通番

centerProcessingDateti

決済センター処理me

日時

vAuthInfo

改ざんチェック用

authParams"AccountAdd"：口座登録結果通知○

27

VeriTrans4G BankPay ご利用ガイド（重要）

これらのパラメータはブラウザを経由して連携されるため、画面遷移が正常に行われないケースでは取得することができません。
そのため、決済サーバーから直接送信される「5-3 結果通知電文」の受信と組み合わせて確実に結果を取得してください。

vAuthInfo および authParams を利用した改ざんチェックについて
決済サーバーから消費者ブラウザを経由して店舗側の結果画面に遷移（リダイレクト）しますが、ここで店舗側システムが受け取ったパラメータが改ざんされていないことを検証するためのパラメータが、vAuthInfo と authParams です。
店舗側システムで算出したハッシュ値が、パラメータより取得した vAuthInfo と一致している場合は、パラメータは改ざんされていな
い、とみなすことができます。
この改ざんチェックは、悪意を持った第三者によって、不正なリダイレクト電文を受信する可能性がありますので、実装を強く推奨しています。
パラメータは将来的に追加される可能性がございます。上記に定義されたフィールド名以外のフィールドが連携された場合でもエラーとならないようご注意ください。

28

VeriTrans4G BankPay ご利用ガイド

5.1.9 口座削除
要求電文 ： BankPayAccountDeleteRequestDto
フィールド名

項目名

memberId

会員 ID

accountId

口座 ID

書式・制限
半角英数字
100 桁以内
半角英数字
100 桁以内

説明

設定

口座登録で指定した値を設定します。

○

口座登録で指定した値を設定します。

○

応答電文 ： BankPayAccountDeleteResponseDto
フィールド名

項目名

書式・制限

説明

設
定

serviceType

決済サービスタイプ

半角英数字
10 桁以内要求電文を送信した決済サービスタイプ○

mstatus

処理結果コード

半角英数字
32 文字以内"success"：正常終了"failure"：異常終了○

vResultCode

詳細結果コード

半角英数字
16 文字

○

merrMsg

エラーメッセージ

txnVersion

MDK バージョン

文字列1024 byte 以内
半角英数字
5桁

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
処理結果を日本語で表示○

processId

処理通番

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
決済サーバーにて採番する処理通番。

memberId

会員 ID

要求電文に設定した値△

accountId

口座ＩＤ

半角英数字
100 桁以内

要求電文に設定した値△

centerTransactionId

決済センター側の
処理通番

半角英数字
36 桁

BankPay にて採番する処理通番△

centerProcessingDatetime

決済センター処理
日時

半角数字
14 桁

BankPay 側で処理された日時を返却します。
（YYYYMMDDhhmmss 形式）

△

半角英数字
100 桁以内
半角英数字
100 桁以内○△29

VeriTrans4G BankPay ご利用ガイド

5.1.10 口座照会
要求電文 ： BankPayAccountGetRequestDto
フィールド名

項目名

memberId

会員 ID

accountId

口座 ID

書式・制限
半角英数字
100 桁以内
半角英数字
100 桁以内

説明設
定

照会対象の会員 ID を指定します。

○

照会対象の口座 ID を指定します。
未指定の場合は、会員 ID に紐づくすべての口座の情報を取
得します。

△

応答電文 ： BankPayAccountGetResponseDto
フィールド名

項目名

serviceType

決済サービスタイプ

mstatus

処理結果コードvResultCode

詳細結果コード

merrMsg

エラーメッセージ

processId

処理通番

txnVersion

MDK バージョン

memberId

会員 ID

accountId

口座 ID

accounts

口座情報の配列

書式・制限

説明

設
定

半角英数字
10 桁以内
半角英数字
32 文字以内
半角英数字
16 文字

要求電文を送信した決済サービスタイプ○"success"：正常終了"failure"：異常終了
処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。

○

文字列1024 byte 以内
半角英数字
100 桁以内
半角英数字
5桁

処理結果を日本語で表示○

決済サーバーにて採番する処理通番。

△

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。
要求電文に設定した値○

要求電文に設定した値

△

半角英数字
100 桁以内
半角英数字
100 桁以内
BankPayAccount
の配列

○

△

△

accountId

口座 ID

半角英数字
100 桁以内

会員 ID に紐づく口座 ID△

maskedAccountNum

口座番号(マスクした値)

半角数字記号7桁

口座番号(マスクした値)△

bankCode

銀行コード

銀行コード

△

branchCode

支店コード

支店コード

△

depositType

預金種目

半角数字
4桁
半角数字
3桁
半角数字
1桁

預金種目
"1": 普通口座△"2": 当座口座
isValid

有効区分

半角英字
5 桁以内

"true"：有効"false"：無効
本パラメータが”false”の場合は決済に利用できませんので、口座削除の実施を推奨します。

△

maskedAccountName

口座名義人名(マス
クした値)

文字列
30 文字以内

口座名義人名(マスクした値)※現在の仕様では設定されることはありません。

△

30

VeriTrans4G BankPay ご利用ガイド

共通
5.2.1 検索■「設定」欄の内容は以下の通りとなります。
要求電文 … 必須項目：○

任意項目：△

設定不可：×

応答電文 … 必ず返戻：○

該当取引存在時に返戻：△

その他条件付：※（条件は説明欄に記入）
返戻なし：×

その他条件付：※■複数指定は 0～の添字を指定します。
例）exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=BankPay■ワイルドカードは値の一部と"*"を組み合わせて検索します。"*"のみの指定はできません。
例）exparam.searchParameters.common.orderId=123*

要求電文 ： SearchRequestDto※ 以下は、共通の検索要求フィールドです。

検索フィールド名
requestId

検索項目名
リクエスト ID

serviceTypeCd

決済サービスタイプ

書式・制限

複数

ﾜｲﾙﾄﾞ

指定

ｶｰﾄﾞ

説明

半角英数字記号 128

リクエスト ID を指定します。指定した場合は、そ

文字以内

れ以外のパラメータは指定できなくなります。

右記参照

○

検索対象の決済を指定します。未指定の場合

設
定

△

△

は、全決済が検索対象となります。
"bankpay"： BankPay
newerFlag

最新トランザクショ

右記参照

成功、失敗に関係なく、最新トランザクションの

ンフラグ

△

みを検索する場合に使用します。
"true"： 1 取引内の最新トランザクションのみ検索"false"： 全てのトランザクションを検索※指定しない場合は"false"になります。

containDummyFla

ダミー決済対象フラ

g

グ

右記参照

ダミー取引も検索する場合に使用します。

△"true"： ダミー取引も検索する"false"： ダミー取引は検索しない※指定しない場合は"false"になります。

maxCount

検索最大件数

1～1000

取得したい検索結果の最大件数です。未指定△の場合、最大値となります。
※短時間で大量の検索を繰り返すような処理は決済サーバーに負荷が掛かりますのでご遠慮頂けますようお願いします。

commonorderId

共通
取引 ID

半角英数字 100 桁以○

検索したい取引 ID を指定します。

△

内
31

VeriTrans4G BankPay ご利用ガイド
orderStatus

取引決済状態

右記参照○

以下のいずれかを指定します。

△" initial "：初期状態" end "：終了
" pending "：保留" validation_error "：検証エラー" expired "：期限切れ" error "：エラー
command

コマンド

右記参照

○

決済で使用するコマンドを指定します。

△" Authorize "：申込（与信または与信＋売上）" Refund "：返金
mstatusステータスコード

右記参照○

決済結果として返戻されるステータスコードを指

△

定します。
" success "：成功" failure "：失敗
" pending "：保留txnDatetime.fr

取引日（From）

文字列 12 桁

取引日時の範囲（From）を指定します。

om△

YYYYMMDDhhmm 形式

txnDatetime.t

取引日（To）

文字列 12 桁

取引日時の範囲（To）を指定します。

o△

YYYYMMDDhhmm 形式

amount.from

金額（From）

数字 12 桁以内

決済金額の範囲（From）を指定します。

△

amount.to

金額（To）

数字 12 桁以内

決済金額の範囲（To）を指定します。

△※「detailOrderType」の詳細は 7-1 検索△※ 以下は、BankPay 固有の検索要求フィールドです。

BankPay

BankPaydetailOrderTy

詳細オーダー決済

pe

状態

右記参照

○

（Search）に関する補足（詳細コマンドタイプ/詳
細オーダー決済状態）を参照

detailComman

詳細コマンドタイプ

右記参照

dType

○

※「detailCommandType」の詳細は 7-1 検索△（Search）に関する補足（詳細コマンドタイプ/詳
細オーダー決済状態）を参照
決済センターのトラ

半角英数字

tionIdンザクション管理 ID

36 桁以内memberId

会員 ID

accountId

口座 ID

centerTransac

半角英数字
100 桁以内
半角英数字
100 桁以内

決済センターがトランザクション毎に発番する IDを指定します。

△

会員 ID を指定します。

△

会員 ID に紐づく口座 ID を指定します。
※口座 ID を設定する場合は、会員 ID の指定が
必須です。

※

32

VeriTrans4G BankPay ご利用ガイド

応答電文 ： SearchResponseDto※ 以下は、共通の検索結果フィールドです。

検索フィールド名
result

検索項目名

書式・制限

説明

設
定

○
○

処理結果

－

serviceType

サービスタイプ

右記参照"search"mstatus

処理結果コード

半角英数字 32 文字処理の結果ステータスが格納されます。
"success"：正常終了"failure"：異常終了○以内
半角英数字 16 文字処理の結果を詳細に表すコードとなります。

○

vResultCode

詳細結果コード

詳細は別途 VResultCodeList を参照下さい。

overMaxCountFlag

最大件数超えフラ

右記参照

グ

検索対象データが要求電文で指定した検索最大件"true"： 最大件数以上

searchCount

検索結果件数orderInfos

オーダー情報リスト

orderInfo

オーダー情報△数より多いかどうかを表します。

0～1000－"false"： 最大件数未満

検索結果件数（オーダー件数）が格納されます。

△

複数のオーダー情報（orderInfo）が格納されます。

△

検索条件に該当した取引の情報が該当件数分繰り△返されます。0～1000 件（要求電文で指定した検索
最大件数まで）となります。
index

インデックス

0～999

検索された情報のインデックスが格納されます。

△

serviceTypeCd

決済サービスタイプ

右記参照

決済の種類が格納されます。
"bankpay"： BankPay△orderId

取引 ID

文字列

取引の取引 ID が格納されます。

△

orderStatus

取引決済状態

右記参照

決済の状態が格納されます。
" initial "：初期状態" end "：終了
" end_presentation "：画面遷移正常終了" pending "：保留" validation_error "：検証エラー" expired "：期限切れ" error "：エラー△※このフィールドは、取引 ID に関連する注文データの状態を完全に表現するものではありません。サービスタイプによっては詳細な状態遷移を別のフィールドに保持している場合がありますので、店舗側システムの用途に合わせて
successDetailTxnType や、決済固有の状態フィー
ルドをご参照ください。
lastSuccessTxnType

最終成功トランザク

文字列

直近の成功したコマンド名が格納されます。

△

文字列

取引の詳細な状態が格納されます。

△

ションタイプsuccessDetailTxnType

詳細トランザクショ
ンタイプ

properOrderInfo

固有オーダー情報

検索要求電文の各決済の detailOrderType 参照。
－

各決済サービスの固有オーダー情報が格納されま△す。後述の一覧参照。

33

VeriTrans4G BankPay ご利用ガイド
transactionInfos

決済トランザクショ－

複数の決済トランザクション情報（transactionInfo）

ンリスト
transactionInfo

決済トランザクショ－

検索条件に該当した取引の情報が該当件数分繰り

ン情報
txnId

トランザクション管△が格納されます。

△

返されます。
文字列

決済サーバーが採番する管理 ID となります。

△

文字列

実行されたコマンド名が格納されます。

△

理 IDcommand

コマンド※MDK で要求したコマンドだけでなく、決済サーバ
ーの内部処理コマンドも含まれます。
mstatus

処理結果コード

半角英数字 32 文字
以内

vResultCode

詳細結果コード

文字列 16 桁

処理の結果ステータスが格納されます。
"success"：正常終了"failure"：異常終了"pending"：保留△処理の結果を詳細に表すコードとなります。

△

詳細は別途 VResultCodeList を参照下さい。
txnDatetime

取引日時

文字列 23 桁

取引日時が格納されます。

amount金額

半角数字 12 桁以内決済した金額が格納されます。

properTransactio

固有トランザクショ－

各決済サービスの固有トランザクション情報が格納

nInfo

ン情報

△

YYYY-MM-DD hh:mi:ss.mmm 形式△△されます。後述の一覧参照。

☆ 以下の情報は、上記 「固有オーダー情報」 「固有トランザクション情報」 内の階層にセットされます。
※ 以下は、BankPay 固有の検索結果フィールドです。
properOrderInfo

BankPay 固有オーダー情報

accountingType

課金種別

右記参照

authorizeAmount

申込金額

半角数字

残高

半角数字

memberId

会員 ID

accountId

口座 ID

authorizeDatetime

決済申込日時

決済申込時に指定した課金種別"0"：都度決済"1"：随時決済"2"：チャージ（オープン）"3"：チャージ（ハウス）△"4"：チャージ（資金移動）
決済申込時に指定した金額

△

現在の残高

△

半角英数字
100 桁以内
半角英数字
100 桁以内
半角数字
14 桁

会員 ID

△

会員 ID に紐づく口座 ID△

決済申込日時

△

半角数字
14 桁

返金日時

7 桁以内
balance

7 桁以内

refundDatetime
properTransactionInfo
bankpayErrorCode
centerTransactionId

返金日時

△

YYYYMMDDhhmmss 形式

BankPay 固有トランザクション情報
BankPay エラーコード
決済センターのトランザク
ション管理 ID

detailCommandType

YYYYMMDDhhmmss 形式

詳細コマンドタイプ

△

半角英数字
7 桁

BankPay 側から返戻されたエラーコードが格納さ

半角英数字

決済センタートランザクション単位に発番する ID△※「detailCommandType」の詳細は「7-1 検索

△

れます。

36 桁以内文字列（Search）に関する補足（詳細コマンドタイプ/詳細
オーダー決済状態）」を参照
storeId

店舗 ID

半角英数字

決済申込もしくは返金時に指定した店舗 ID△
34

VeriTrans4G BankPay ご利用ガイド
5桁
terminalId

端末機識別番号

半角数字
13 桁

bankpayRequestDatetime

決済センターへの要求日時

bankpayResponseDatetime

決済センターからの返戻日
時

半角数字
14 桁
半角数字
14 桁

決済申込もしくは返金時に指定した端末機識別番△

号
決済センターへの要求日時が格納されます。

△

YYYYMMDDhhmmss 形式
決済センターからの返戻日時が格納されます。

△

YYYYMMDDhhmmss 形式

35

VeriTrans4G BankPay ご利用ガイド

結果通知電文5.3.1 結果通知電文の概要
実装方法の詳細につきましては、弊社より提供しているサンプルプログラムをご参照ください。


機能概要

決済サーバーから店舗様システムへ決済の結果通知を行います。
通知は、HTTP の POST を利用します。
※ プロトコルは HTTP（Port：80）、HTTPS（Port：443）に対応しています。
処理の概要については「第 4 章 結果通知受信処理」をご参照ください。

HMAC について

POST にてデータを通知するとき、リクエストヘッダーに HMAC を設定します。
また、HMAC 値は、リクエストボディから算出します。
アルゴリズムは「HmacSHA256」が設定されます。
フィールド名

設定値

content-hmac

h={アルゴリズム名};s={CCID};v={HMAC 値}
表 5.1 リクエストヘッダーに設定する HMAC フィールド

結果通知受信処理結果について

決済サーバーからの通知に対して店舗様システムが HTTP ステータスコード"200"を返戻した場合、受信処理が正常に終了したものと判断します。"200"以外のコードを返した場合は、受信失敗と判断し、一定期間、通知を繰り返します。
※

規定の回数失敗した場合は、通知処理が停止しますのでご注意ください。

5.3.2 BankPay の結果通知電文
BankPay における結果通知電文の通知タイミングは、下記となります。
No.

通知機能

1

口座登録結果通知（AccountAdd）

通知タイミング

注意事項

口座登録が確定（成功、失敗）したタイミン
グで送信します。
口座登録が中断した場合は、成功、失敗が確定したタイミングで通知を行います。
表 5.2 BankPay の結果通知機能
以下に、BankPay の結果通知項目を示します。

項

フィールド名

番

項目名

書式・制限

1

numberOfNotify

通知件数

半角数字 4 桁以内

2

pushTime

送信時刻

半角数字 14 桁

3

pushId

識別 ID

半角数字 8 桁

説明
1 度に通知可能な件数は 100 件、
101 件以上は次回通知
決済サーバーから通知した時刻
yyyyMMddHHmmss 形式
プッシュ処理を行うたびに採番される ID。
注） 他の決済サービスで使用された ID と重複する場合があります。

通知件数分下記の項番（4～14）を繰り返す。尚、フィールド名の後ろに 4 ケタの連番（0000～0999）を付与する。

4

txnType

トランザクションタイプ

5

txnTime

処理日時

文字列
32 文字以内
半角数字 14 桁

実行したコマンド名。
"AccountAdd"：口座登録結果通知
yyyyMMddHHmmss 形式36

VeriTrans4G BankPay ご利用ガイド
vResultCode

詳細結果コード

半角英数字
16 文字

6

処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途 VResultCodeList を参照下さい。
"success"：正常終了

7

mstatus

処理ステータス

半角英数字 8 桁以内

8

dummy

ダミー決済フラグ

半角数字 1 桁

ダミー取引を示す場合は"1"を設定します。

processId

処理通番

半角英数字
100 桁以内

決済サーバーにて採番する処理通番。

memberId

会員 ID

半角英数字

リクエストされた値

accountId

口座ＩＤ

半角英数字
100 桁

リクエストされた値

bankCode

銀行コード

半角数字
4桁

登録された銀行コードを返却します。

branchCode

支店コード登録された支店コードを返却します。

depositType

預金種目

半角数字
3桁
半角数字

9
10
11
12
13

"failure"：異常終了

100 桁以内

1桁14

登録された預金種目を返却します。
"1": 普通口座"2": 当座口座

15
16
17
18

maskedAccountNum

半角数字記号

口座番号7桁
maskedAccountName

文字列

口座名義人名30 文字以内
centerTransactionId

決済センター側の処理
通番

centerProcessingDatetime

半角英数字
36 桁

半角数字
14 桁
表 5.3 BankPay の結果通知項目

決済センター処理日時

登録された口座番号(マスクした値)を返却します。
登録された口座名義人名(マスクした値)を返却します。
BankPay にて採番する処理通番
BankPay 側で処理された日時を返却します。
YYYYMMDDhhmmss 形式（注意事項）


pushId（識別 ID）は、他の決済サービスで使用された Id と重複する場合がありますので、ユニークキーとして処理しないようにしてください。



項目の並び順は、必ずしも表の順序とは一致しません。



結果通知は将来的にフィールドが追加される可能性がございます。上記に定義されたフィールド名以外のフィールドが連携された場
合でもエラーとならないようご注意ください。



口座登録失敗時や、途中離脱のリカバリ処理などにより口座登録結果が確定した場合は、パラメータの設定値が空になるケースが存在します。

37

VeriTrans4G BankPay ご利用ガイド

第6章 ご利用上の注意事項
会員登録での遷移について
6.1.1 銀行選択画面
消費者が口座を登録する際、銀行毎に入力が必要な情報が異なります。
そのため、まずは銀行を選択する画面を表示して、銀行選択後は「5.1.6 口座入力情報取得」コマンドを実施して、入力が必要な項目を取得します。

6.1.2 口座情報入力画面「6.1.1 銀行選択画面」で取得した情報をもとに、口座登録に必要な情報を入力するための画面を表示します。
口座情報入力後、「5.1.7 口座登録」コマンドを実施して、BankPay への登録に必要な情報を取得します。

6.1.3 BankPay への遷移処理「6.1.2 口座情報入力画面」で取得した情報をもとに、BankPay への遷移を実施します。

■電文仕様
項目

仕様

遷移先 URL「5.1.7 口座登録」コマンドのレスポンスパラメータの”bankpayAccountsRegisterUrl”の値

HTTP Version

1.1

HTTP Metohd

POST

EncodeUTF-8content-typeapplication/x-www-form-urlencoded※その他のリクエストヘッダについては RFC に準じて設定してください。

■パラメータフィールド名

項目名

bankCode

銀行コード

branchCode

支店コード

depositType

accountNum
accountName

accountLabel

預金種目

口座番号
口座名義人名

口座ラベル

書式・制限
半角数字
4桁
半角数字
3桁
半角数字
1桁
半角数字
7桁
全角英数カナ記号
30 桁以内文字列
50 桁以内説明「5.1.6 口座入力情報取得」コマンドで"bankCode "に指定した値
口座情報入力画面で入力した値

設
定

○
△
(※1)

口座情報入力画面で入力した値"1": 普通口座"2": 当座口座
口座情報入力画面で入力した値

△
(※1)

△
(※1)

口座情報入力画面で入力した値
使用可能文字については「7-2 使用可能文字」を参照してください。
「5.1.7 口座登録」コマンドのレスポンスパラメータの"accountLabel"の値

△
(※1)

○

38

VeriTrans4G BankPay ご利用ガイド
フィールド名

設
定

項目名

書式・制限

説明

backURL

戻り先 URLURL に使用可
能な半角文字256 桁以内「5.1.7 口座登録」コマンドのレスポンスパラメータの"backUrl"の値○

cAccessToken

会員用アクセスト
ークン

半角英数字
32 桁

「5.1.7 口座登録」コマンドのレスポンスパラメータの"customerAccessToken "の値○

processorAuthenticationKeyIndex

Pay 事業者認証
鍵世代番号

文字列
2桁

「5.1.7 口座登録」コマンドのレスポンスパラメータの"processorAuthenticationKeyIndex"の値○

mac

メッセージ認証
コード

文字列
44 桁

「5.1.7 口座登録」コマンドのレスポンスパラメータの"mac"の値○※1) 「5.1.6 口座入力情報取得」コマンドのレスポンスで”true”となっている項目は必須■リクエストサンプル<form method="post" action="https://example.com/hogehoge"><input type="hidden" name="bankCode" value="0000"><input type="hidden" name="branchCode" value="001"><input type="hidden" name="depositType" value="1"><input type="hidden" name="accountNum" value="1234567"><input type="hidden" name="accountName" value="テストタロウ"><input type="hidden" name="accountLabel" value="test"><input type="hidden" name="backURL" value="https://example.com/fugafuga"><input type="hidden" name="cAccessToken" value="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"><input type="hidden" name="processorAuthenticationKeyIndex" value="01"><input type="hidden" name="MAC" value="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"></form>39

VeriTrans4G BankPay ご利用ガイド

会員・口座の登録について
6.2.1 同一口座の登録について
複数の会員で同一の口座を登録した場合、新しく登録した方は利用可能となりますが、先に登録した方は利用不可となります。
利用不可となった口座は、口座照会コマンドのレスポンスパラメータの「isValid」が”false”となりますので、利用不可となった口座は口座削除コマンドを実施することを推奨します。

例） memberId1 に紐づく accountId1 と同じ口座情報を memberId2 に紐づけて口座登録を実施
会員 ID

口座 ID

銀行

口座番号

有効区分

accountId1

ABC 銀行

1111111true

accountId2

DEF 銀行

2222222true

accountId3

ABC 銀行

3333333

true

memberId1
memberId2

↓
会員 ID

口座 ID

銀行

口座番号

有効区分

accountId1

ABC 銀行

1111111

false

accountId2

DEF 銀行

2222222true

accountId3

ABC 銀行

3333333

true

accountId4

ABC 銀行

1111111true

memberId1

memberId2

6.2.2 登録可能な口座数の上限について
会員毎に紐づけ可能な口座情報は最大 8 口座となります。

返金可能期間について返金処理は決済申込を実施した当日中のみ可能です。
ただし、金融機関のサービス利用時間外などの理由により、当日中であってもエラーとなる可能性はございます。

40

VeriTrans4G BankPay ご利用ガイド

第7章その他

補足事項

検索（Search）に関する補足（詳細コマンドタイプ/詳細オーダー決済状態）
決済サーバーでは、システム内部データとして詳細コマンド（処理要求の種類）と詳細な決済状態（その取引がどのような状態にあるか）を管理しています。
通常の運用では、店舗様システムではこれらの内部情報を利用する必要はありませんが、店舗様システムにおいて取引の状態検索が必要なケースや、障害等のお問い合わせ時の参照情報として、これらの内部データを Search コマンドで公開しています。
下表に Search コマンドにて利用可能な内部データの一覧を示します。

詳細コマンドタイプ
論理名

詳細オーダー決済状態
値

論理名

値

売上（与信売上）

AuthCapture

与信売上AuthCapture

取消（与信売上）

VoidAuthCapture

取消（与信売上）

VoidAuthCapture

表 7.1 詳細コマンドタイプと詳細オーダー決済状態
注） 一覧に記載していないコマンドタイプと状態も存在します。

使用可能文字BankPay で使用可能な文字を以下の表の通りです。
■ 氏名(userName)、カナ氏名(userNameKana)、住所(address)、摘要(remarks)
型

半角数字
半角英字
半角カナ

半角記号
全角文字

使用可能文字

0123456789
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
ｱ ｲ ｳ ｴ ｵ ｶ ｷ ｸ ｹ ｺ ｻ ｼ ｽ ｾ ｿ ﾀ ﾁ ﾂ ﾃ ﾄ ﾅ ﾆ ﾇ ﾈ ﾉ ﾊ ﾋ
ﾌ ﾍ ﾎ ﾏ ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾖ ﾗ ﾘ ﾙ ﾚ ﾛ ﾜ ｦ ﾝｧ ｨ ｩ ｪ ｫ ｯ ｬ ｭ ｮﾞ ﾟ!"#$%&'()*+,-./@[\]^_`{|}~
半角スペースUnicode3.0.0 までに収録されている文字■ 口座名義人(accountName)
型

全角数字
全角英字

全角カナ

使用可能文字０ １ ２ ３ ４ ５ ６ ７ ８ ９
Ａ Ｂ Ｃ Ｄ Ｅ Ｆ Ｇ Ｈ Ｉ Ｊ Ｋ Ｌ Ｍ Ｎ Ｏ Ｐ Ｑ Ｒ Ｓ Ｔ Ｕ Ｖ Ｗ Ｘ
Ｙ Ｚ
ａ ｂ ｃ ｄ ｅ ｆ ｇ ｈ ｉ ｊ ｋ ｌ ｍ ｎ ｏ ｐ ｑ ｒ ｓ ｔ ｕ ｖ ｗ ｘ ｙ ｚ
ア イ ウ エ オ カ キ ク ケ コ サ シ ス セ ソ タ チ ツ テ ト ナ
ニ ヌ ネ ノハ ヒ フ ヘ ホ マ ミ ム メ モ ヤ ユ ヨ ラ リ ル レ ロ ワ ヲ ン
ヴ ガ ギ グ ゲ ゴ ザ ジ ズ ゼ ゾ ダ ヂ ヅ デ ド バ ビ ブ ベ
ボ パ ピ プ41

VeriTrans4G BankPay ご利用ガイド

ペ ポァ ィ ゥ ェ ォ ヵ ヶ ッ ャ ュ ョ ヮ（ ） ー 全角スペース※金融機関によって、上記以外に使える記号も存在します。

全角記号※口座名義人について、銀行毎の使用不可の文字は以下の表の通りです（2022/12/16 時点）
今後 BankPay に対応した銀行については、上記の表に記載があっても使用不可の可能性がございますので、ご注意ください。
銀行型

三菱 UFJ 銀行※先頭に使用不可

全角数字
全角カナ
全角記号
全角数字
全角英字
全角カナ

住信 SBI ネット銀行

使用不可文字すべてヲ ァ ィ ゥ ェ ォ ャ ュ ョ ッ ヵ ヶ ヮ）全角スペース
すべて
すべて
ヵ ヶ ヮ

42

VeriTrans4G BankPay ご利用ガイド

第8章 導入・テストに関する補足
決済サーバーに接続し、テストを実施するための各種手続き・手順の詳細につきましては、『導入テストガイド』を参照してください。

口座登録時の画面遷移をシミュレートする弊社では、BankPay のテストのための疑似環境を提供しております。
ダミー取引で「6.1.3 BankPay への遷移処理」を実施すると、口座登録の認証画面のイメージが表示されます。

図 8.1 疑似環境（ダミーBankPay－ログイン画面）

口座登録の認証画面からの遷移先の対応表を以下に記載します。

認証画面

決済結果画面からの遷移先

成功

決済完了時 URL

処理結果 NG を引き渡す

決済エラー時 URL

不正なパラメータを引き渡す

決済サーバーのエラー画面

43

VeriTrans4G BankPay ご利用ガイド

Authorie, Refund コマンドのエラーをシミュレートする
Authorize、Refund コマンドの要求金額（"amount"）の一の位の値を調整することで、意図的にエラーを発生させることができます。
（Refund コマンドで金額を指定しない場合は、対象取引の返金可能金額が要求金額に相当します。）
要求金額の下一桁と、返戻される vResultCode の対応表を以下に記載します。

金額のAuthorize

Refund

下1桁（決済申込）（返金）

0B001（成功）

1

B001（成功）

BGD1（失敗）

2

BE50（ペンディング)

3

BGD1（失敗）

4

BE50（ペンディング)

56B001（成功）

7

B001（成功）89

会員系コマンドのエラーをシミュレートする
MemberAdd、MemberUpdate、MemberDelete コマンドの会員 ID（"memberId"）の末尾 1 文字の値を調整することで、意図的にエラーを発生させることができます。
会員 ID の末尾 1 文字と、返戻される vResultCode の対応表を以下に記載します。
会員 ID のMemberAdd

MemberUpdate

MemberDelete

末尾 1 文字（会員登録）（会員情報更新）（会員削除）

0

B001（成功）

1

BGD2（失敗）

B001（成功）

2

B001（成功）

3

BGD2（失敗）

4
5
6
7
8

BGD2（失敗）
B001（成功）B001（成功）B001（成功）9
その他の文字44VeriTrans4G BankPay ご利用ガイド

口座系コマンドのエラーをシミュレートする
PrepareAccountAdd、AccountAdd、AccountDelete、AccountGet コマンドの口座 ID（"accountId"）の末尾 1 文字の値を調整することで、意図的にエラーを発生させることができます。
口座 ID の末尾 1 文字と、返戻される vResultCode の対応表を以下に記載します。
口座 ID のPrepareAccountAdd

AccountAdd

AccountDelete

AccountGet

末尾 1 文字（口座入力情報取得）（口座登録）（口座削除）（口座照会）

0

B001（成功）

1

BGD3（失敗）

B001（成功）※1
2

B001（成功）

3

B001（成功）
BGD3（失敗）※2
4
5

BGD3（失敗）

6

B001（成功）B001（成功）

7

BGD3（失敗）※1

8B001（成功）B001（成功）9※2
その他の文字※1 口座登録の認証画面への遷移については、「8-1 口座登録時の画面遷移をシミュレートする」を参照してください。
※2 口座照会コマンドで取得できる口座情報は、口座登録で入力した値ではなく固定値となります。

ダミー取引で登録した会員・口座情報のデータ保持期間について
ダミー取引にて登録した会員・口座情報のデータ保持期間は、取引データの保持期間と同様になります（会員登録をした日から算出）。

45