DGFT Veritrans4G開発ガイド

お問い合わせ
  • TOP
  • MDK(SDK)導入ガイド
  • 開発環境へのMDK(SDK)導入
  • ワンクリック継続課金(サブスクリプション)

インターフェース詳細(会員管理機能)

本ガイドについて

本ガイドの内容

本ガイドには、VeriTrans4G ワンクリック継続課金サービス 会員管理機能において利用できる電文のインターフェース仕様を記載しています。
各電文には、本ガイドの表、および「VeriTrans4G開発ガイド」に記載されていない項目が定義されている場合がありますが、
本ガイドの表、および「VeriTrans4G開発ガイド」に記載されていない項目は店舗様では使用することはできません。

対象者

ワンクリック継続課金サービスを利用する店舗の開発者

関連ドキュメント

接続APIの概要、電文作成方法等については、「VeriTrans4G 開発ガイド」を参照して下さい。

Dto名一覧

ワンクリック継続課金サービス 会員管理機能にて利用可能な電文のDto名を以下の表に記載します。
各Dtoで利用可能な電文項目の詳細は、「要求電文項目定義」、「応答電文項目定義」を参照して下さい。

※ ×:実行不可

インターフェース詳細(会員管理機能) シート名「Dto名一覧」(zip形式/70.6kb)

コマンド
Add Update Delete Restore Get Link Copy
サービスタイプ 種別 追加 変更 削除 復元 取得 紐付 複製
"account" 会員情報 要求電文 AccountAddRequestDto AccountUpdateRequestDto AccountDeleteRequestDto AccountRestoreRequestDto × AccountLinkRequestDto AccountCopyRequestDto
応答電文 AccountAddResponseDto AccountUpdateResponseDto AccountDeleteResponseDto AccountRestoreResponseDto × AccountLinkResponseDto AccountCopyResponseDto
"recurring" 継続課金管理 要求電文 RecurringAddRequestDto RecurringUpdateRequestDto RecurringDeleteRequestDto × RecurringGetRequestDto × ×
応答電文 RecurringAddResponseDto RecurringUpdateResponseDto RecurringDeleteResponseDto × RecurringGetResponseDto × ×
"cardinfo" 登録カード管理 要求電文 CardInfoAddRequestDto CardInfoUpdateRequestDto CardInfoDeleteRequestDto × CardInfoGetRequestDto × ×
応答電文 CardInfoAddResponseDto CardInfoUpdateResponseDto CardInfoDeleteResponseDto × CardInfoGetResponseDto × ×
"bankAccount" 登録口座管理 要求電文 BankAccountAddRequestDto × BankAccountDeleteRequestDto × × × × ※1
応答電文 BankAccountAddResponseDto × BankAccountDeleteResponseDto × × × × ※1

※1:銀行振込決済サービス利用者のみ対象

以下の場合は、カードの有効性確認(2円与信)が発生します。この時の取引IDは「SCREENING_xxxx」となります。
2円与信が失敗した場合は会員登録、カード登録、カード変更は実施されません。

accountAdd トークン(またはカード番号と有効期限)が設定された場合
recurringAdd トークン(またはカード番号と有効期限)が設定された場合
recurringUpdate トークン(またはカード番号と有効期限)が設定された場合
cardInfoAdd トークン(またはカード番号と有効期限)が設定された場合
cardInfoUpdate トークン(またはカード番号と有効期限)が設定された場合
cardInfoUpdate 有効期限のみが設定された場合

要求電文項目定義

ワンクリック継続課金サービス 会員管理機能の要求電文項目を記載します。各要求電文のDto名は、「Dto名一覧」を参照して下さい。
要求電文は、サービスタイプ、コマンドにより設定可能な項目が異なります。下記表の設定欄をご確認ください。

尚、各電文には、以下の表、およびVeriTrans4G開発ガイドに記載されていない項目が定義されている場合がありますが、以下の表、およびVeriTrans4G開発ガイドに記載されていない項目は店舗様では使用することはできません。

※その他、各決済の要求電文項目については、VeriTrans4G開発ガイドを参照して下さい。

【設定】 ○ : 必須項目、× : 利用不可項目、△ : 任意項目、■n : 条件付必須項目一つでも入力があれば全て必須

※または※n : その他条件付(条件は説明欄、または欄外に記入)

インターフェース詳細(会員管理機能) シート名「要求電文項目定義」(zip形式/70.6kb)

設定
ワンクリック継続課金サービス 会員管理機能
account(会員情報) recurring
(継続課金管理)
cardinfo
(登録カード管理)
bankAccount
(登録口座管理)
フィールド名 項目名 属性 桁数 説明 Add Update Delete Restore Link Copy Add Update Delete Get Add Update Delete Get Add Delete
accountId 会員ID 半角英数字 100桁以内 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能。
originalAccountId 元会員ID 半角英数字 100桁以内 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能。 × × × × × × × × × × × × × × ×
createDate 入会年月日 半角数字 8桁 YYYYMMDD形式

※過去日は設定不可、未来日は設定可能です。

× × × × × × × × × × ×
deleteDate 退会年月日 半角数字 8桁 YYYYMMDD形式

※過去日は設定不可、未来日は設定可能です。

× × × × × × × × × × × × × ×
forceDeleteDate 強制退会フラグ 半角数字 1桁 継続課金中であっても強制的に退会するか否か指定するフラグ
"1":強制的に終了する。(以降課金は継続課金は発生しない。)
"0":継続課金中の場合、退会できない。

※未設定時は"0"が設定されます。

× × × × × × × × × × × × × ×
deleteCardInfo カード情報削除フラグ 半角数字 1桁 退会時にクレジットカード情報を削除するか否か指定するフラグ
"1":クレジットカード情報を削除する。
"0":クレジットカード情報を削除しない。

※未設定時は"0"が設定されます。

× × × × × × × × × × × × × ×
deleteOriginalAccountId 元会員ID退会フラグ 半角数字 1桁 複製時に元会員を退会するか否か指定するフラグ
0:元会員を退会しない
1:元会員を退会する

※未設定時は"0"が設定されます。

× × × × × × × × × × × × × × ×
addCardInfo カード情報追加フラグ 半角数字 1桁 登録する会員IDが既に存在する場合に、既存の会員IDにカード情報を追加するか否か指定するフラグ
0:カード情報を追加しない
1:カード情報を追加する

※未設定時は"0"が設定されます。

Linkで利用する際は、既に会員に紐づいているカード情報の場合に、登録済のカード情報を返戻するか否か指定するフラグ
0:処理失敗とし、登録済のカード情報を返戻しない
1:処理成功とし、登録済のカード情報を返戻する(パラメータに応じて、登録済のカード情報を更新してから返戻する)

※未設定時は"0"が設定されます。

× × × × × × × × × × × × × ×
defaultCardOnly 標準カード限定フラグ 半角数字 1桁 複製時に標準カードのみ追加するか否か指定するフラグ
"0":元会員に紐づく全てのカード情報を追加する。
"1":元会員に紐づく標準カードのみ追加する。

※未設定時は"0"が設定されます。

× × × × × × × × × × × × × × ×
cleaningConfig 洗替設定フラグ 半角数字 1桁 複製先のカード情報を洗替するか否か指定するフラグ
"0":洗替しない。
"1":洗替する。

※未設定時は"1"が設定されます。

※洗替を実施しないマーチャントで複製した場合は、本項目に関わらず、洗替は行われません。

× × × × × × × × × × × × × × ×
cardId カードID 半角英数字 100桁以内 会員管理で管理しているカード情報を決済で利用する場合に指定 × × × × × × × × × × × ×
defaultCard 標準カードフラグ 半角数字 1桁 "1":指定されたカードを標準カードにする (デフォルト)
"0":標準カードの設定を変更しない

※未設定時は"1"となります。

「標準カード」とは、カード情報を決済時の要求電文に含めなかった場合に使用されるカードのことです。
"1"を指定した場合は、今回指定したカードが新たに標準カードになります。
"0"を指定した場合は、標準カードの設定は変更されません。
(今まで標準カードに設定されていたカードが、今後も標準カードとして利用されます。)
× × × × × × × × × ×
defaultCardId 標準カードID 半角英数字 100桁以内 カード削除リクエスト時のみ設定可能
標準カードとして設定しているカード情報を削除する際に、新しく標準カードとして扱うカードを指定します。
× × × × × × × × × × × × × × ×
cardNumber カード番号 半角数字 16桁

(重要)カード情報の非保持(非通過、非保持)への対応のため、
通常は設定しないでください。

クレジットカード番号を指定
数字のみ、またはハイフン含みで指定します。(ハイフン含みの場合は19桁以内で指定)
サービスタイプ"cardinfo"(登録カード管理)のUpdateコマンドの場合を除き、カードIDを指定した場合は、本項目は指定不可です。
■1 ※1
■2 ※2
× × × × × ■2 ※2 ■2 ※2 × × ※2 ■2 ※2 × × × ×
cardExpire 有効期限 半角数字 5桁

(重要)カード情報の非保持(非通過、非保持)への対応のため、通常は、カード番号と同時に設定しないでください。(Update時、有効期限のみの設定は可)

クレジットカードの有効期限を指定
MM/YY (月 + "/" + 年)の形式 (例 "08/")
サービスタイプ"cardinfo"(登録カード管理)のUpdateコマンドの場合を除き、カードIDを指定した場合は、本項目は指定不可です。
■1 ※1
■2 ※2
× × × × × ■2 ※2 ■2 ※2 × × ※2 ※3 × × × ×
securityCode セキュリティコード 半角数字 4桁以内

(重要)カード情報の非保持(非通過、非保持)への対応のため、通常は、カード番号、
有効期限と同時に設定しないでください。(Update時、有効期限と同時設定は可)

セキュリティコード
× × × × × × × × × ×
cardholderName カード保有者名 半角英数字記号 2~45桁

(重要)カード情報の非保持(非通過、非保持)への対応のため、通常は、カード番号、
有効期限と同時に設定しないでください。(Update時、有効期限と同時設定は可)

クレジットカードの名義人を指定

※3Dセキュア2.0を利用する場合、事前に会員IDと紐付けるか、決済リクエスト時に指定する必要がございます。

× × × × × × × × × ×
token トークン 半角英数字記号 36桁 クレジットカード情報に紐づくトークンを指定
右記一覧について、トークンを利用しないDTOを利用しても、入力チェックはしておりません。
※7 × × × × × ※7 ※7 × × ※7 ※7 × × × ×
cardNumberMaskType カード番号マスクタイプ 半角数字 1桁 応答電文のマスクカード番号のマスク方法を指定
"0": 先頭6桁と下2桁のみ数字表記され、その他は "*"(アスタリスク)
"1": 先頭6桁と下4桁のみ数字表記され、その他は "*"(アスタリスク)

※未設定時は"0"が指定されます。

× × × × × × × × × × × × × × ×
withAuthorize 与信実施フラグ 半角数字 1桁 カード情報を更新する際に2円与信するか否か指定するフラグ。カード情報の変更有無に関わらず、本フラグで与信の実施有無を判断します。
"0":与信しない。
"1":与信する。

※未設定時はカード情報を変更した場合のみ与信が実施されます。

※与信を実施せずに登録したカードはそのままでは洗替対象にはなりません。

× × × × × × × × × × × × ×
updater 洗替実施フラグ 半角数字 1 通常は設定しないでください。
ワンクリック継続課金利用中に洗替の実施有無を切り替える場合に利用します。

"1":洗替する
"0":洗替しない

※未設定時は洗替可能なマーチャント場合、1が設定されます。

※洗替を実施するマーチャントのみ設定可能です。

× × × × × × × × × ×
groupId 課金グループID 半角英数字 50桁以内 課金グループを識別するためのID
事前に登録済みの課金グループIDのみ指定可能です。
以下の文字も使用できます。
"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)

※課金グループIDについては、VeriTrans4G 開発ガイドを参照して下さい。

■1 ※1 × × × × × × × × × × × ×
startDate 課金開始日 半角数字 8桁 課金を開始する日付(YYYYMMDD形式)

※初回課金される日付ではありません。

継続課金スケジュール日程の参照を開始する日付を指定します。
× × × × × △ ※4 × × × × × × × ×
endDate 課金終了日 半角数字 8桁 課金を終了する日付(YYYYMMDD形式)

※最後に課金される日付ではありません。

継続課金スケジュール日程の参照を終了する最終日を指定します。

※この項目を設定する場合は、finalCharge(次回課金終了フラグ)に、「"1":次回課金日で終了」を設定しないでください。エラーとなります。

× × × × × × × × × × × ×
finalCharge 次回課金終了フラグ 半角数字 1桁 次回課金をもって課金を終了する場合に設定するフラグ
"1":次回課金日で終了
"0":課金終了日で終了

※未設定時は"0"が設定されます。

※「"1":次回課金日で終了」を設定する場合は、endDate(課金終了日)を設定しないでください。エラーとなります。

× × × × × × × × × × × × × × ×
oneTimeAmount 都度/初回課金金額 半角数字 8桁以内 都度課金時、または継続課金時の初回の課金金額
都度課金の場合は、次回課金時の金額を指定します。
継続課金の場合は、課金グループにて指定している金額とは異なる金額で決済したい場合に設定します。

※継続課金では、初回の課金処理に成功しなかった場合、次回の課金スケジュール時を初回として処理します。(課金金額も「初回課金金額」が適用されます)
初回課金処理に成功しない限り、次回の課金スケジュール時に「継続課金金額」に指定した課金金額は適用されません。ご注意ください。
※課金グループについては、VeriTrans4G 開発ガイドを参照して下さい。

× × × × × × × × × × × × ×
amount 継続課金金額 半角数字 8桁以内 継続課金時、2回目以降の決済金額
課金グループにて指定している金額とは異なる金額で決済したい場合に設定します。

※1回目の課金に継続課金金額は加算されないので注意して下さい。
※継続課金では、初回の課金処理に成功しなかった場合、次回の課金スケジュール時を初回として処理します。(課金金額も「初回課金金額」が適用されます)
初回課金処理に成功しない限り、次回の課金スケジュール時に「継続課金金額」に指定した課金金額は適用されません。ご注意ください。
※課金グループについては、VeriTrans4G 開発ガイドを参照して下さい。

× × × × × × × × × × × × ×
recurringMemo1 継続課金用メモ1 文字列 100文字以内 継続課金時に取引に関するメモ情報を付加することができる。 × × × × × × × × × × × × ×
recurringMemo2 継続課金用メモ2 文字列 100文字以内 継続課金時に取引に関するメモ情報を付加することができる。 × × × × × × × × × × × × ×
recurringMemo3 継続課金用メモ3 文字列 100文字以内 継続課金時に取引に関するメモ情報を付加することができる。 × × × × × × × × × × × × ×
bankCode 金融機関コード 半角数字 4桁 金融機関コード ※5 × × × × × × × × × × × × × ※6
branchCode 支店コード 半角数字 3桁 支店コード × × × × × × × × × × × × × × ※6
accountType 口座種別 半角数字 1桁 "1":普通
"2":当座
× × × × × × × × × × × × × × ※6
accountNumber 口座番号 半角数字 7桁 口座番号 × × × × × × × × × × × × × × ※6
accountManageType 口座管理方式 半角数字 1桁 "0": 実口座
"1": バーチャル口座

※未設定時は"0"が指定されます。

× × × × × × × × × × × × × ※6
rejectBankAccount 銀行口座関連付け拒否フラグ 半角数字 1桁 会員IDと口座情報の紐づけをさせない為のフラグです。
"0":会員情報と銀行口座情報を関連付ける。
"1":会員情報と銀行口座情報を関連付けない。

※未設定は"0"が指定されます。

× × × × × × × × × × × × × × × × ※6
originalOrderId 元取引ID 半角英数字 100桁以内

一部記号も利用可能です。決済時の取引IDと同じフォーマットになります。

会員IDとカード決済で利用したカード情報を紐付けるために使用する取引ID

※決済サーバーに取引履歴が保管されている期間は標準で400日間となります。保管期間の起算日の考え方は、取引のステータスが最後に変化した日が起算日となりますので、直近で使用した取引IDを指定することをお薦めいたします。

× × × × × × × × × × × × × × ×
cleaningMerchantId 洗替実施マーチャントID 半角英数字 22桁 登録するマーチャントIDとは別のマーチャントIDで洗替を行いたい場合に指定します。

※ワンクリック継続課金サービスでマーチャントIDをグルーピングしているマーチャントIDでのみご利用可能になれます。

× × × × × × × × × × × × × × ×

bankAccountのAdd/Deleteは銀行振込決済サービス利用者の対象となります。

※1 : 会員課金情報を指定する場合、課金グループID、カード情報(カード番号、有効期限)の設定が必要になりますが、通常はカード情報の代わりにトークン(token)を設定するようにして下さい。
※2 : カード情報を指定する場合、通常はカード番号、有効期限の代わりにトークン(token)を設定するようにして下さい。
※3 : 有効期限のみの設定が可能です。
※4 : 既に課金開始日を過ぎている場合は、「課金開始日」を変更することはできません。
※5 : 口座情報を指定する場合は金融機関コードの設定は必須です。
※6 : 銀行振込決済サービス利用者のみ対象
※7 : トークンを設定する際は、カード番号、カード有効期限およびセキュリティコードを設定することはできません。

応答電文項目定義

ワンクリック継続課金サービス 会員管理機能の応答電文項目を記載します。各応答電文のDto名は、「Dto名一覧」を参照して下さい。
応答電文では、各Dtoで返戻される項目は共通です。

尚、各電文には、以下の表、およびVeriTrans4G開発ガイドに記載されていない項目が定義されている場合がありますが、以下の表、およびVeriTrans4G開発ガイドに記載されていない項目は店舗様では使用することはできません。

※その他、各決済の応答電文項目については、VeriTrans4G開発ガイドを参照して下さい。

【設定】 ○:通常は返戻、 △:処理成功時のみ返戻、 □:入力チェックエラーの場合は返戻なし、 ×:返戻なし、 ※:その他条件付

※「○」について、特定のエラー(例:通信エラー、無効なトークンを指定)が発生した場合、一部の項目は返戻なしとなります。

インターフェース詳細(会員管理機能) シート名「応答電文項目定義」(zip形式/70.6kb)

設定
account
(会員情報)
recurring(継続課金管理) cardinfo(登録カード管理) bankAccount
(登録口座管理)
その他
フィールド名 項目名 属性 桁数 説明 Add Link Copy Add Update Get Add Update Get Add Delete
serviceType 決済サービスタイプ 半角英数字 10桁以内 要求電文を送信した決済サービスタイプ
mstatus 処理結果コード 半角英数字 32文字以内 "success":正常終了
"failure":異常終了
vResultCode 詳細結果コード 文字列 16桁 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は別途VResultCodeListを参照して下さい。
merrMsg エラーメッセージ 文字列   処理結果を日本語で表示
txnVersion MDK バージョン 半角英数字
5桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。
payNowIdResponse 会員管理オブジェクト オブジェクト 会員管理機能の戻り値を格納するオブジェクト
processId 会員管理処理番号 半角英数字 20桁以内 会員管理処理要求を一意に識別する番号
status 会員管理ステータス 半角英数字 20桁以内 会員管理処理要求の実行結果
"success":成功
"failure":失敗
message 会員管理メッセージ 文字列 100文字以内 会員管理処理要求の実行結果メッセージ
account 会員情報 オブジェクト 会員情報の戻り値を格納するオブジェクト
  accountId 会員ID 半角英数字 100桁以内 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能
cardInfo   カード情報 オブジェクト配列 カード情報を格納するオブジェクト × × ×
cardId カードID 半角英数字 100桁以内 決済サーバーにて付与されたカードIDが返戻されます。 × × ×
cardNumber マスクカード番号 半角英数字 16桁以内 カード番号の先頭6桁と下2桁(※)のみ数字表記され、その他は "*"(アスタリスク)に変換されます。ハイフンは含まれません。(例"411111********11")
要求電文の「cardNumber(カード番号)」にてハイフン含みで指定した場合も、ハイフンは含まれずに返戻されます。

※サービスタイプ"cardinfo"(登録カード管理)のGetコマンドで、カード番号マスクタイプを指定した場合は、マスク方法を変更できます。

× × ×
cardExpire 有効期限 半角英数字 5桁 MM/YY形式
マスクされずに返戻されます。
× × ×
defaultCard 標準カードフラグ 半角数字 1桁 カード情報を明示的に指定せず決済する場合に使用するカードか否かを示すフラグ
"1":決済時、カード情報を明示的に指定しない場合に使用されるカード
"0":決済時、カード情報を明示的に指定しない場合に使用されるカードではない
× × ×
kindCode 券種コード 半角英数字 10桁以内 券種を判定するコード

※ベリトランス決済サーバに判定用のBINとコード値を設定しておく必要がございます。詳細につきましてはお問い合わせください。

× × × × × ×
originalCardId 元カードID 半角英数字 100桁以内 元会員に紐づいていたカードIDが返戻されます。
元々、会員に紐づいていたカード情報の場合は返戻されません。
× × × × × × × × × × ×
cardholderName カード保有者名 半角英数字記号 2~45桁 カードの名義人
マスクされずに返戻されます。
× × ×
recurringCharge 会員課金情報 オブジェクト配列 会員課金情報を格納するオブジェクト × × × × × × × × × × ×
groupId 課金グループID 半角英数字 50桁以内 継続課金対象の課金グループID × × × × × × × × × × ×
cardId カードID 半角英数字 100桁以内 継続課金対象のカードID × × × × × × × × × × ×
bankAccountInfo 銀行口座情報 オブジェクト 銀行口座情報を格納するオブジェクト × × × × × × × × × ※1
bankCode 金融機関コード 半角数字 4桁 口座番号に紐づく金融機関コード × × × × × × × × × ※1
branchCode 支店コード 半角数字 3桁 口座番号に紐づく支店コード × × × × × × × × × ※1
accountType 口座種別 半角数字 1桁 口座番号に紐づく口座種別 × × × × × × × × × ※1
accountNumber 口座番号 半角数字 7桁 口座番号 × × × × × × × × × ※1
accountName 口座名義 文字列 40桁以内 口座番号に紐づく口座名義 × × × × × × × × × ※1

※ payNowIdResponseオブジェクトは、JSONから生成されたオブジェクトです。
また、payNowIdResponseオブジェクト内のそれぞれのパラメタやオブジェクトも同様です。

例えば、会員情報追加応答(AccountAddResponseDto)から会員IDを取得する場合は、以下のようにアクセスします。
accountAddResponseDto.getPayNowIdResonse().getAccount().getAccountId();

※1 : 銀行振込決済サービス利用者のみ対象

注)クレジットカードの有効性確認について
accountのAddコマンド、cardinfoのAdd/Updateコマンド、recurringのAdd/Updateコマンドの場合、リクエストに指定されたクレジットカード情報(カード番号/有効期限)の有効性確認を行う為、内部で有効性確認(2円与信)を実施します。
有効性確認(2円与信)の結果、有効と判断されなかった場合、vResultCode(詳細結果コード)にXH41000000000000、またはXH41Axx00000000(Axxxは決済時のエラーコード)を設定し、返戻します。
また、詳細についてmerrMsg(エラーメッセージ)にクレジットカード決済の結果コードを返戻しますのでクレジットカード決済の結果コード一覧をご確認ください。