インターフェース詳細(ワンクリック継続課金サービス)
本ドキュメントについて
本ガイドの内容
株式会社DGフィナンシャルテクノロジーが提供する「ワンクリック継続課金サービス」をインターネット店舗などに導入する開発者向けに、電文インターフェース、CSVファイルフォーマットを記載しています。
関連ドキュメント
タイトル | 概要 |
---|---|
VeriTrans4G開発ガイド | VeriTrans4Gの概要と、MDK(Merchant Development Kit)の導入方法等が記載されています。 |
VeriTrans4Gインターフェース詳細~(サービス名)~ | VeriTrans4Gで利用可能な各決済サービスのインターフェース詳細が記載されています。 |
VeriTrans4G 開発ガイド ワンクリック継続課金サービス 会員管理機能 インターフェース詳細 | VeriTrans4G ワンクリック継続課金サービス 会員管理機能において利用できる電文のインターフェース仕様が記載されています。 |
ワンクリック継続課金サービス 運用ガイド | VeriTrans4G ワンクリック継続課金サービスの運用者ならびに開発者向けに、運用スケジュール(処理フロー)、ファイルフォーマット(CSV)、メールフォーマット等が記載されています。 |
MDKトークン 開発ガイド | MDKトークンを利用して決済を行うために必要な情報が記載されています。 |
MDKインターフェース詳細
本章では、MDKを利用して「ワンクリック継続課金サービス」を利用する際に、各決済サービスの要求/応答電文(Dto)に追加で設定可能なフィールドを説明します。
- 要求電文 ...
- 必須項目:○ 任意項目:△ 設定不可:× その他条件付:※、※n(条件は説明欄、または欄外に記入)
- 応答電文 ...
- 必ず返戻:○ 処理成功時のみ返戻:△ 返戻なし:× その他条件付:※、※n(条件は説明欄、または欄外に記入)
会員管理機能
店舗様が運営するECサイト等の利用会員(消費者)に関連付ける「会員情報」の追加や、変更、削除を行うには、以下に示す「会員管理コマンド」を実行します。
会員管理コマンド | 名称 | 説明 |
---|---|---|
Add | 追加 | 会員情報を追加します。 |
Update | 変更 | 登録されている会員情報を変更します。 |
Delete | 削除 | 登録されている会員情報を削除します。 |
Restore | 復元 | 削除された会員情報の復元を実行します。 |
Get | 取得 | 登録されている会員情報を取得します。 |
Link | 紐付 | 会員情報とカード決済で利用したカード情報を紐付けます。 |
Copy | 複製 | 登録されている会員情報を複製します。 |
「会員管理コマンド」を実行する際には、管理対象の「会員ID」および、下表に示す「サービスタイプ」を組み合わせて指定します。
サービスタイプ | 名称 | 説明 |
---|---|---|
"account" | 会員情報 | 会員情報の管理、編集を行います。 |
"recurring" | 継続課金管理 |
継続課金を行う際の、継続課金開始/終了、継続課金金額の管理、編集を行います。 課金方式はあらかじめ登録されている必要があります。詳細は、『ワンクリック継続課金サービス 運用ガイド』を参照して下さい。 ※"recurring"(継続課金管理)では、クレジットカード支払の場合のみ継続課金の機能を提供しています。 |
"cardinfo" | 登録カード管理 | 会員IDに紐付くカード情報の管理、編集を行います。 |
「サービスタイプ」と利用できるコマンドの対応表を以下に示します。 (○:実行可能、×:実行不可)
コマンド名 | Add | Update | Delete | Restore | Get | Link | Copy | |
---|---|---|---|---|---|---|---|---|
サービスタイプ | "account" | ○ | ○ | ○ | ○ | × | ○ | ○ |
"recurring" | ○ | ○ | ○ | × | ○ | × | × | |
"cardinfo" | ○ | ○ | ○ | × | ○ | × | × |
会員管理コマンドを実行するために必要なパラメータの詳細は、『ワンクリック継続課金サービス 会員管理機能 インターフェース詳細』を参照して下さい。
会員管理コマンドでカード登録を行った場合は、自動的に2円与信が発生します。この時の取引IDは「SCREENING_xxxx」となります。
パラメータ(与信実施フラグ)を利用することで、2円与信を発生させないことも可能です。与信を実施せず登録したカードはそのままでは洗替対象になりません。
会員管理コマンドを利用せずに、決済の要求と同時に会員登録を実行する機能につきましては、「2-2 会員ID指定による決済機能」をご参照ください。
サービスタイプ "account"(会員情報)
サービスタイプ"account"(会員情報)では、各コマンドによって以下の処理を行うことができます。
コマンド名 | 処理内容 |
---|---|
Add |
|
Update |
|
Delete |
|
Restore |
【重要】 |
Get |
|
Link |
|
Copy |
(注意事項) |
サービスタイプ "recurring"(継続課金管理)
サービスタイプ"recurring"(継続課金管理)では、各コマンドによって以下の処理を行うことができます。
※会員IDが登録されていない場合は、エラーが発生しますのでご注意ください。
コマンド名 | 処理内容 |
---|---|
Add |
※課金情報の削除時に「課金終了日」に未来日を指定した場合、課金終了日を迎えるまで同一「課金グループID」の課金情報を再度登録することはできません。 ※当該会員IDに紐付ける課金情報の「課金グループID」は、あらかじめ登録されている必要があります。詳細は、 |
Update |
※当該会員IDに紐付ける課金情報の「課金グループID」は、あらかじめ登録されている必要があります。詳細は、 |
Delete |
※「課金終了日」に次回課金日を指定すると次回継続課金処理で課金実施後、課金終了となります。 |
Restore |
|
Get |
|
Link |
|
Copy |
|
サービスタイプ "cardinfo" (登録カード管理)
サービスタイプ"cardinfo"(登録カード管理)では、各コマンドによって以下の処理を行うことができます。
※会員IDが登録されていない場合は、エラーが発生しますのでご注意ください。
コマンド名 | 処理内容 | |
---|---|---|
Add |
|
|
Update |
|
|
Delete |
|
|
Restore |
|
|
Get |
|
|
Link |
|
|
Copy |
|
会員ID指定による決済機能
要求電文の共通項目について
ワンクリック継続課金サービスをご利用の場合は、各決済サービスの決済コマンド要求時に会員IDを指定することで、取引に対して当該会員の取引であることを記録することができます。
また、新規の会員IDが指定された場合には、会員登録処理が行われます。
会員IDを指定する場合は、各サービスの要求電文に以下のフィールドを追加してください。
要求電文 | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
accountId | 会員ID | 半角英数字100桁以内 |
取引に紐付ける会員IDを指定します。 新しい会員IDを指定した場合は、会員登録処理が行われます。 会員IDには、半角英数字以外に"."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能です。 |
△ |
クレジットカード決済実行時の会員ID管理と決済機能
クレジットカード決済時には、通常のカード決済の処理と同時に以下の3つの機能を利用できます。
- 新規会員の追加登録
新規会員IDを指定することで、会員IDとクレジットカード情報を紐付けることができます。 - 継続課金データの登録
新規会員の継続課金データを登録することができます。 - 会員ID+カードIDによる決済
決済要求時にカード番号を指定することなく、登録済みのカード番号で決済を行うことができます。
これらの機能を利用する場合は、以下の電文に、必要な要求パラメータを設定してください。
対象サービス | コマンド | 電文名(Dto) |
---|---|---|
クレジットカード決済 | Authorize(与信) | CardAuthorizeRequestDto |
MPI(本人認証) | Authorize(認可) | MpiAuthorizeRequestDto |
※CardReAuthorizeRequestDto、MpiReAuthorizeRequestDtoでは動作保証しておりませんので、使用しないでください。
以下に、要求パラメータを説明します。
要求電文 : CardAuthorizeRequestDto/MpiAuthorizeRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
accountId | 会員ID | 半角英数字100桁以内 |
取引に紐付ける会員IDを指定します。 新しい会員IDを指定した場合は、会員登録処理が行われます。 会員IDには、半角英数字以外に"."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能です。 |
※1 |
cardId | カードID | 半角英数字100桁以内 | ワンクリック継続課金サービスの会員管理で管理しているカード情報を決済で利用する場合に指定 | ※1 |
defaultCard | 標準カードフラグ | 半角数字1桁 |
"1":指定されたカードを標準カードにする (デフォルト)
「標準カード」とは、カード情報をリクエストに含めなかった場合に使用されるカードのことです。 |
△ |
※以下は、継続課金データの登録を行う場合に設定 | ||||
groupId | 課金グループID | 半角英数字50桁以内 |
継続課金対象の課金グループID ※事前に登録済みの課金グループIDのみ指定可能です。 ※"."(ドット)、"-"(ハイフン)、"_"(アンダースコア)も使用可能です。 |
※2 |
startDate | 課金開始日 | 半角数字8桁 |
継続課金の処理を開始する日付(YYYYMMDD形式) ※初回課金される日付ではありません。 |
※2 |
endDate | 課金終了日 | 半角数字8桁 |
継続課金の処理を終了する日付(YYYYMMDD形式) ※最後に課金される日付ではありません。 |
※2 |
oneTimeAmount | 初回課金金額 | 半角数字8桁以内 | 継続課金時の初回の課金金額 課金グループに設定されている金額とは異なる金額で決済したい場合に設定します。 |
※2 |
recurringAmount | 継続課金金額 | 半角数字8桁以内 |
継続課金時、2回目以降の決済金額 ※初回課金金額が指定されている場合、1回目の課金時に、ここで指定した金額は利用されません。 |
※2 |
以下のフィールドは、3Dセキュア利用時に会員ID(accountId)を設定する場合は、必ず設定を確認してください。
要求電文 : MpiAuthorizeRequestDto | ||||
---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
tempRegistration | 仮登録フラグ | 半角数字1桁 |
このパラメータを利用すると、3Dセキュア(本人認証+カード決済)の利用時に、カード情報(および継続課金データ)が登録されるタイミングを制御できます。 3Dセキュアの認可が成功した時点で、カード情報を仮登録扱いにするかどうかを以下のフラグで指定します。 "0": 仮登録扱いにしない(認可が成功した時点でカード情報を登録する) "1": 仮登録扱いとする(認可成功時点では仮登録とし、カード決済の成功時にカード情報を本登録する) ※未設定時は"0"です。 |
△ |
3Dセキュア利用時の注意事項(重要)
3Dセキュア利用の決済と併せて、会員IDに新しいカードを登録する、または継続課金を登録するための3つの方法について説明します。
仮登録フラグ(tempRegistration)を利用した方法(1. 2.)、決済時には会員IDおよび関連情報を何も指定せずに後から登録を行う方法(3.)がありますので、それぞれの特徴を踏まえて、どの方法を利用するかをご検討ください。
-
仮登録フラグが"0"の場合
3Dセキュア利用の決済要求時に会員IDを設定し、仮登録フラグ(tempRegistration)を【"0": 仮登録扱いにしない】にすると、認可(本人認証の前処理)が成功した時点、すなわち、本人認証およびクレジットカードの有効性の確認が行われる前の時点でカードが登録される挙動になります。- その時点で使用できないカードが登録される場合があります。
- 継続課金に関するフィールドを設定した場合は、使用できないカードで継続課金が登録されることがあります。
そのため、認証や与信がNGとなった場合には、必ず登録されたカードの削除や、継続課金登録の解除を行ってください。
-
仮登録フラグが"1"の場合
3Dセキュア利用の決済要求時に会員IDを設定し、仮登録フラグ(tempRegistration)を【"1": 仮登録扱いとする】にすると、本人認証が成功し、クレジットカードの有効性が与信によって確認されたカードのみが登録されます。ただし、決済の結果を取得するインターフェース(結果通知やブラウザを介した結果の連携)では、カード登録の結果(登録の成否およびカードID)や継続課金登録の結果を取得できません。カード登録や継続課金登録結果の詳細を取得するためには、別途、会員管理機能のインターフェースを利用して後から取得する必要があります。 -
「会員ID紐付」を利用して後から会員登録を実行する場合
会員管理機能の会員ID紐付(account.Link)を実行すれば、3Dセキュア利用の決済要求時には会員IDを設定せずに、決済に利用されたカード情報と会員IDを後から紐付けることができます。継続課金を登録したい場合は会員ID紐付の後に、継続課金登録(recurring.Add)を実行します。
※1:カード番号、カード有効期限、会員ID、カードID、トークンの設定における制約について
パターン | 設定項目 | 説明 |
---|---|---|
1 | カード番号、およびカード有効期限 |
|
2 | 会員ID、およびカードID |
|
3 | 会員IDのみ |
|
4 | トークン |
|
会員ID(accountId)に新規の会員IDを設定した場合は、任意項目となります。
会員ID(accountId)に設定した会員が、既存会員(既にワンクリック継続課金サービスの会員管理機能にて管理されている)の場合、設定不可項目となります。既存会員の継続課金データを登録したい場合は、「2-1会員管理機能」をご利用ください。
会員管理オブジェクト(payNowIdResponse)について
各決済サービスの要求電文に「accountId(会員ID)」を設定した場合、応答電文にて「payNowIdResponse(会員管理オブジェクト)」が返戻されます。
会員IDの登録処理結果は、payNowIdResponseオブジェクト内の各パラメータにて確認してください。
返戻される項目を以下に記載します。
応答電文 | |||||||
---|---|---|---|---|---|---|---|
フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |||
payNowIdResponse | 会員管理オブジェクト | オブジェクト |
ワンクリック継続課金サービス 会員管理機能の戻り値を格納するオブジェクト
※要求電文で会員IDを設定した場合に、会員管理オブジェクトが返戻されます。ただし、決済パラメータ入力チェックエラーが発生した場合、会員管理オブジェクトは返戻されません。 |
※1 | |||
processId | 会員管理処理番号 | 半角英数字20桁以内 | 会員管理処理を一意に識別する番号 決済サーバーより付与されます。 | ※1 | |||
status | 会員管理ステータス | 半角英数字20桁以内 | 会員管理処理要求の実行結果 "success":成功 "failure":失敗 | ※1 | |||
message | 会員管理メッセージ | 文字列100文字以内 | 会員管理処理要求の実行結果メッセージ | ※1 | |||
account | 会員情報 | オブジェクト | 会員情報の戻り値を格納するオブジェクト | ※1 | |||
accountId | 会員ID | 半角英数字100桁以内 | "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 | ※1 | |||
cardInfo | カード情報 | オブジェクト配列 | カード情報を格納するオブジェクト | ※1 ※2 |
|||
cardId | カードID | 半角英数字100桁以内 | 決済サーバーにて付与されたカードIDが返戻されます。 | ※1 ※2 |
|||
cardNumber | マスクカード番号 | 半角英数字16桁以内 | カード番号の先頭6桁と下2桁のみ数字表記され、その他は "*"(アスタリスク)に変換されます。ハイフンは含まれません。(例"411111********11") 要求電文の「cardNumber(カード番号)」にてハイフン含みで指定した場合も、ハイフンは含まれずに返戻されます。 | ※1 ※2 |
|||
cardExpire | 有効期限 | 半角英数字5桁 | MM/YY形式 マスクされずに返戻されます。 | ※1 ※2 |
|||
defaultCard | 標準カードフラグ | 半角数字1桁 |
カード情報を明示的に指定せず決済する場合に使用するカードか否かを示すフラグ "1":決済時、カード情報を明示的に指定しない場合に使用されるカード "0":決済時、カード情報を明示的に指定しない場合に使用されるカードではない |
※1 ※2 |
|||
cardholderName | カード保有者名 | 半角英数字記号2桁以上、45桁以内 | カードの名義人 マスクされずに返戻されます。 | ※1 ※2 |
※1 「payNowIdResponse」オブジェクトについて
payNowIdResponseオブジェクトは、JSON形式で表現されています。
例えば、クレジットカード決済与信応答(CardAuthorizeResponseDto)から会員IDを取得する場合は、以下のようにアクセスします。
cardAuthorizeResponseDto.getPayNowIdResonse().getAccount().getAccountId();
※2 「cardInfo(カード情報)」オブジェクトについて
クレジットカード決済の与信の要求電文(CardAuthorizeRequestDto)、本人認証の与信の要求電文(MpiAuthorizeRequestDto)において、「accountId(会員ID)」を指定した場合、対応する応答電文にて「cardInfo(カード情報)」オブジェクトが返戻されます。
結果通知
課金結果通知
課金結果通知は、継続課金処理失敗時(与信売上処理失敗時)のみPUSH送信されます。成功時は送信されません。
課金結果通知は、継続課金処理失敗となった取引について、継続課金処理当日中に決済サーバーから店舗様へ送信します。
結果通知電文インターフェースは以下のとおりです。結果通知に関するサービス共通の仕様については、『開発ガイド』を併せてご参照ください。
項番 | フィールド名 | 項目名 | 書式・制限 | 説明 |
---|---|---|---|---|
1 | numberOfNotify | 通知件数 | 半角数字4桁以内 |
結果通知電文に含まれる課金処理失敗通知の総数 1度に通知可能な件数は1,000件 対象が1,001件以上ある場合は、1000件単位で複数回PUSH送信を行います。 |
2 | pushTime | 送信時刻 | 半角数字14桁 | 決済サーバーから通知した時刻 YYYYMMDDhhmmss形式 |
3 | pushId | 識別ID | 半角英数字8桁 |
プッシュ処理を行うたびに採番されるID※"-" (ハイフン)を含みます。
注) 他の決済サービスで使用されたIDと重複する場合があります。 |
通知件数分下記の項番(4~12)を繰り返す。尚、フィールド名の後ろに4ケタの連番(0000~0999)を付与する。 | ||||
4 | accountId | 会員ID | 半角英数字100桁以内 | 以下の文字を含む場合もあります。 ". " (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク) |
5 | orderId | 取引ID | 半角英数字100桁以内 | 決済サーバーにて付与された取引ID。 以下の文字を含む場合もあります。 "-" (ハイフン)、"_" (アンダースコア) |
6 | txnType | トランザクションタイプ | 半角英数字10桁以内 | "recurring" |
7 | mstatus | 処理ステータス | 半角英数字10桁以内 | "failure":課金失敗 ※通知するのは課金失敗の場合のみです。 |
8 | txnTime | 処理日時 | 半角数字14桁 | YYYYMMDDhhmmss形式 |
9 | chargeGroupId | 課金グループID | 半角英数字50桁以内 | 以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア) |
10 | chargeAmount | 課金金額 | 半角数字8桁以内 | |
11 | chargeDate | 課金実施年月日 | 半角数字8桁 | YYYYMMDD形式 |
12 | dummy | ダミー決済フラグ | 半角数字1桁 | ダミーデータを示す場合は"1"を設定 |
- 課金結果通知機能をご利用の場合は、MAPの各種設定変更より、継続課金失敗結果通知先URLを設定してください。
- pushId(識別ID)は、他の決済サービスで使用されたIDと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
- 項目の並び順は、必ずしも表の順序とは一致しません。
洗替結果通知
洗替結果通知は、洗替処理失敗時のみPUSH送信されます。処理成功時は送信されません。
洗替の有効性判定結果は、以下の6種類ですが、このうちPUSHの対象となるのは、'1':無効、'2':照合エラー、'5':結果データなしの3種類です。
'1':無効
'2':照合エラー
'3':仕向先なし
'4':洗替対象外
'5':結果データなし
PUSH対象のであっても削除されたカードの場合は、PUSH通知されません。
洗替結果通知は、カード会社から決済サーバーに洗替結果が届いた翌日に、洗替処理失敗となったクレジットカード情報をまとめて決済サーバーより店舗様へ送信します。
結果通知電文インターフェースは以下のとおりです。結果通知に関するサービス共通の仕様については、『開発ガイド』を併せてご参照ください。
項番 | フィールド名 | 項目名 | 書式・制限 | 説明 |
---|---|---|---|---|
1 | numberOfNotify | 通知件数 | 半角数字4桁以内 |
結果通知電文に含まれる洗替処理失敗通知の総数 1度に通知可能な件数は1,000件 対象が1,001件以上ある場合は、1000件単位で複数回PUSH送信を行います。 |
2 | pushTime | 送信時刻 | 半角数字14桁 | 決済サーバーから通知した時刻 YYYYMMDDhhmmss形式 |
3 | pushId | 識別ID | 半角英数字8桁 |
プッシュ処理を行うたびに採番されるID※"-" (ハイフン)を含みます。
注) 他の決済サービスで使用されたIDと重複する場合があります。 |
通知件数分下記の項番(4~11)を繰り返す。尚、フィールド名の後ろに4ケタの連番(0000~0999)を付与する。 | ||||
4 | accountId | 会員ID | 半角英数字100桁以内 | 以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク) |
5 | txnType | トランザクションタイプ | 半角英数字10桁以内 | "cardcheck" |
6 | txnTime | 処理日時 | 半角数字14桁 | 決済サーバーにて処理された日時 YYYYMMDDhhmmss形式 |
7 | cardId | カードID | 半角英数字100桁以内 | |
8 | cardNo | カード番号 | 半角数字16桁 | カード番号の上6桁下2桁のみ数字表記され、その他は"*"でマスクされます。 (例"411111********11") |
9 | cardExpire | カード有効期限 | 半角英数字5桁 | MM/YY形式 |
10 | cardCheckStatus | 洗替ステータス | 半角数字1桁 | "1":無効、"2":照合エラー、"5":結果データなし |
11 | dummy | ダミー決済フラグ | 半角数字1桁 | ダミーデータを示す場合は"1"を設定 |
- 洗替結果通知機能をご利用の場合は、MAPの各種設定変更より、洗替失敗結果通知先URLを設定してください。
- pushId(識別ID)は、他の決済サービスで使用されたIDと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
- 項目の並び順は、必ずしも表の順序とは一致しません。
CSVファイルフォーマット
各機能にて店舗様と弊社サーバー間で授受を行うCSVファイルのフォーマットを記載します。
尚、1ファイルの最大レコード件数は、100万件です。
また、文字コード、改行コードが以下の表に記載のものと異なる場合、エラーが発生します。
- ファイル名 : アップロードしたCSVファイルと同名で拡張子を「.rec」とする。
例)CSVファイルが「aabbcc001.csv」であれば「aabbcc001.rec」というファイル名にする。 - ファイルサイズ : 0 byte
※rec ファイルが配置されない場合、CSV ファイルの取り込みは行われません。
弊社が所定のディレクトリに結果CSVファイルを配置する場合もrecファイル(レシートファイル)を配置します。recファイル(レシートファイルがファイル配置完了の目印となります。
SFTP接続でCSVファイルのアップロード、ダウンロードする際のファイル配置先のディレクトリは以下の仕様で決まります。
/マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/xxxxxx
アルファベット変換ルールは次のとおりです。
CSVファイルの文字コード、改行コードについては、各ファイルに記載されているコードで作成してください。
文字コード、改行コードが指定されているものと異なっている場合、以下のエラーが出力されます。
XH86,受付データチェックエラーです。ファイル名:xxxxxxxxx.csv
XH87,ファイルフォーマットが正しくありません。(空行、空ファイル、読込み不可) ===================================
- CSVファイルにカード番号・有効期限を入力して使用する場合は、PCI-DSS準拠が必要です。
- カード番号が記載されたCSVファイル(会員情報登録、決済登録依頼)をMAPからアップロードするためには、決済サーバ側での許可設定が必要となります。詳細につきましては、テクニカルサポート(tech-support@veritrans.jp)までお問い合わせください。
- MAPとsFTPの両方をご利用される場合は、必ずそれぞれ別のファイル名になるようにしてください。同名のファイルをアップロードした場合、想定通りの動作とならない場合がございます。
会員情報登録
「4.1.1 会員登録CSVファイル」にフォーマットエラー、整合性エラー*1がない場合は、レコードが処理され、「4.1.2 会員登録結果CSVファイル」が出力されます。(MAPではダウンロードできません。)。
「4.1.1 会員登録CSVファイル」にフォーマットエラー、整合性エラー*1がある場合は、レコードは処理されず、「4.7.1 エラーCSVファイル(会員情報登録)」が出力されます。CSVファイルを修正し、再度アップロードしてください。
*1 既に登録されている会員データの状態と、要求内容が矛盾する場合のエラーを示す。
例) ・入会済みの会員IDを入会しようとした
・退会済みの会員IDを更新しようとした
・入会済みの会員IDを再入会しようとした
会員登録CSVファイル
会員登録に使用するCSVファイルのフォーマットを以下に記載します。
- (重要)カード番号・有効期限を入力するには、PCI DSS準拠が必要です。
- 会員登録CSVファイルでのカード登録時は、カードの有効性の確認は実施されません(与信は発生しません)。
- 既存の会員IDにカードを追加した場合、そのカードは標準カードにはなりません(標準カードは変わりません)。
ファイル名 | 半角英数字のみで任意(記号不可) | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/account/in |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
2 行目 | ||||
レコード種別 | - | - | ○ | "head_account"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "data_account"固定 |
会員ID | 半角英数字 | 100 | ○ | 消費者を一意に識別するID "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 |
カード番号 | 半角数字 | 16 | △ ※1 |
カード番号(ハイフン無しの数字のみで指定します。) "NO_CARD"が指定された場合はカード登録しない。 16桁未満の場合、先頭に0を付与する等の加工をしないでください。 |
有効期限 | 半角英数字 右記参照 | 5 | △ ※1 |
カード有効期限(MM/YY (月 + "/" + 年)の形式 (例 "08/")) |
洗替対象フラグ | 半角数字 | 1 | △ ※1 |
「カード番号」で指定したクレジットカードを洗替対象とするか否かを指定 "0":対象外、"1":対象 |
課金グループID | 半角英数字 | 50 | △ ※2 |
課金グループを一意に識別するID デフォルトの課金グループを利用する場合も設定が必要です。 未指定の場合は「継続課金を行わない会員登録」の扱いとなります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)も使用可能 |
課金グループ登録種別 | 半角数字 | 1 | △ ※2 |
課金グループへの処理種別 課金グループIDが指定されている場合は必須となります。 "1":新規登録(会員に課金グループを登録する場合) "2":変更(既に登録されている情報の変更。例:継続課金金額の変更) 注)課金グループ情報の変更を行うと標準カードに課金グループが紐づきます。課金に使用されるカードが変更される可能性がありますのでご注意ください。 |
都度/初回課金金額 | 半角数字 | 8 | ※3 | 初回のみ加算する金額(入会金等) 指定がない場合は、課金グループIDに登録された初回課金額が登録されます。 |
継続課金金額 | 半角数字 | 8 | ※3 | 継続課金の課金金額 指定がない場合は、課金グループIDに登録された継続課金金額が登録されます。 |
課金開始年月日 | 半角数字 右記参照 | 10 | ※3 | 継続課金を開始する年月日(YYYY/MM/DD形式) 指定がない場合は、処理当日の年月日を登録します。 |
課金終了年月日 | 半角数字 右記参照 | 10 | ※3 | 継続課金を終了する年月日(YYYY/MM/DD形式) 指定がない場合は9999年12月31日で登録します。 |
入会年月日 | 半角数字 右記参照 | 10 | 処理区分が"登録"、または"再入会"で指定がない場合は、処理当日の年月日を登録します。(YYYY/MM/DD形式) | |
退会年月日 | 半角数字 右記参照 | 10 | 処理種別が"退会"で退会年月日が未設定の場合は、処理当日の年月日が設定されます。(YYYY/MM/DD形式) 継続課金中の場合、強制的に退会となります。 退会年月日以降の課金は行われません。(退会年月日当日を含む) |
|
処理種別 | 半角数字 | 1 | ○ |
会員に対する処理の種別を指定します。 "1":入会 "2":変更 "3":退会 "4":再入会 継続課金情報を登録する場合、新規会員登録を同時に行うときには「"1":入会」を、すでに登録されている会員に対して登録するときは「"2":変更」を指定してください。 |
カード保有者名 | 半角英数字 記号 | 2~45 | ※4 |
処理種別が"登録"、"変更"、"再入会"の場合は設定可能です。
※退会時は設定不可 |
最終行 | ||||
レコード種別 | - | - | ○ | "footer_account"固定 |
データ件数 | 半角数字 | 8 | ○ | 会員登録データ件数 |
※1 カード番号、有効期限、洗替対象フラグは揃って未設定もしくは設定済にしてください。ただし"NO_CARD"は除きます。
※2 課金グループID、課金グループ登録種別は揃って未設定もしくは設定済にしてください。
※3 いずれかの項目を設定する場合は、課金グループID、および課金グループ登録種別を設定してください。
※4 カード保有者名を設定しない場合、データ部末尾の「,」は設定不要となります。「,」のみ設定しても問題ありません。
【会員登録CSVファイルのサンプル(accountA10000000000000xxxxxxx.csv)】
head_merchant,A10000000000000xxxxxxx
head_account,1
data_account,DEFAULT_F0000001,4111111111111111,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000002,5555555555554444,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000003,5105105105105100,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000004,5500000000000004,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000005,3528000000000007,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000006,3528000000000015,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000007,3528000000000023,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000008,3530111333300000,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000009,378282246310005,06/14,1,DEFAULT,1,,,,,,,1,CARDHOLDERNAME
data_account,DEFAULT_F0000010,36666666666660,06/14,1,DEFAULT,1,,,,,,,1,
footer_account,10
【会員登録CSVファイルの登録パターン別必須項目】
会員IDを登録 | 会員IDとカードを登録 | 会員IDとカードと課金グループを登録 | 既存会員IDにカードを登録 | 既存会員IDにカードと課金グループを登録 | 既存会員IDに課金グループを登録 ※1 |
課金グループ情報の変更 ※2 |
退会 | 再入会 | |
---|---|---|---|---|---|---|---|---|---|
レコード種別 | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
会員ID | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
カード番号 | × | ○ | ○ | ○ | ○ | × | × | × | × |
有効期限 | × | ○ | ○ | ○ | ○ | × | × | × | × |
洗替対象フラグ | × | ○ | ○ | ○ | ○ | × | × | × | × |
課金グループID | × | × | ○ | × | ○ | ○ | ○ | × | × |
課金グループ登録種別 | × | × | 1 | × | 1 | 1 | 2 | × | × |
都度/初回課金金額 | × | × | △ | × | △ | △ | △ | × | × |
継続課金金額 | × | × | △ | × | △ | △ | △ | × | × |
課金開始年月日 | × | × | △ | × | △ | △ | △ | × | × |
課金終了年月日 | × | × | △ | × | △ | △ | △ | × | × |
入会年月日 | △ | △ | △ | × | × | × | × | × | △ |
退会年月日 | × | × | × | × | × | × | × | △ | × |
処理種別 | 1 | 1 | 1 | 2 | 2 | 2 | 2 | 3 | 4 |
カード保有者名 | × | △ | △ | △ | △ | × | × | × | △ |
必須項目:○ 任意項目:△ 設定不可:×
※1 課金グループは標準カードに紐づきます。
※2 課金グループ情報の変更を行うと標準カードに課金グループが紐づきます。課金に使用されるカードが変更される可能性がありますのでご注意ください。
会員登録結果CSVファイル
会員登録結果のCSVファイルのフォーマットを以下に記載します。
※継続課金情報の登録が成功した場合のお知らせも「会員登録結果CSVファイル」にて行います。
ファイル名 | 会員登録依頼ファイル名 + ".success" | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/account/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
2行目 | ||||
レコード種別 | - | - | ○ | "head_account"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
3行目 | ||||
結果メッセージ | 全角 | - | ○ | 処理したファイル名 + "正常に処理完了しました。" |
データ件数 | 半角数字 | 8 | ○ | 会員登録データ登録件数 |
【会員登録結果CSVファイルのサンプル(accountA10000000000000xxxxxxx.csv.success)】
head_merchant,A10000000000000xxxxxxx
head_account,1
accountA10000000000000xxxxxxx.csv 正常に処理完了しました。,10
会員ID紐付
「4.2.1 会員ID紐付依頼CSVファイル」にフォーマットエラーがない場合は、レコードが処理され、「4.2.2 会員ID紐付結果CSVファイル」が出力されます。
「4.2.1 会員ID紐付依頼CSVファイル」にフォーマットエラーがある場合は、レコードが処理されず、「4.7.2 エラーCSVファイル(会員ID紐付、決済登録)」が出力されます。CSVファイルを修正し、再度アップロードしてください。
会員ID紐付依頼CSVファイル
元取引IDと会員IDを紐付けて会員登録およびカード登録を依頼する際に使用するCSVファイルのフォーマットを以下に記載します。
ファイル名 | 半角英数字のみで任意(記号不可) | 形式 | CSVファイル |
---|---|---|---|
文字コード | Shift-JIS | 改行コード | CRLF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/linkaccount/in |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "10003"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
2 行目 | ||||
レコード種別 | - | - | ○ | "21000"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ |
"42001"固定
旧バージョンは"42000"固定 |
会員ID | 半角英数字 | 100 | ○ | 消費者を一意に識別するID "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 |
取引ID | 半角英数字 | 100 | ○ | 元取引ID |
入会年月日 | 半角数字 | 8 | YYYYMMDD形式 未指定の場合は当日で登録します。 | |
標準カードフラグ | 半角数字 | 1 |
標準カードフラグ "1":標準使用されるカードとして登録する。 "0":標準使用されるカードとして登録しない。 未指定の場合は標準仕様されるカードとして登録します。 |
|
洗替対象フラグ | 半角数字 | 1 | クレジットカードを洗替対象とするか否かを指定 "0":対象外、 "1":対象 未指定の場合は洗替対象とします。 |
|
カード保有者名 | 半角英数字記号 | 2~45 |
カード保有者名
この項目は2022年6月に追加されました。旧バージョンにはありません。 |
|
最終行-1行 | ||||
レコード種別 | - | - | ○ | "29000"固定 |
マーチャント毎データ件数 | 半角数字 | 8 | ○ | 店舗様毎の取引ID依頼データ件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "90003"固定 |
データ総件数 | 半角数字 | 8 | ○ | 取引ID登録データ総件数 |
- 値を指定しない場合はカンマ(,)のみ記入してください。例)下記サンプルの3行目
- 行の最後尾に値指定がない場合もカンマ(,)は必要です。例)下記サンプルの4行目
【会員ID紐付依頼CSVファイルのサンプル(linkaccount A10000000000000xxxxxxx.csv)】
10003,0
21000,A10000000000000106XXXX
42001,account_test0001,ORDER_ID_0000001,,,,
42001,account_test0002,ORDER_ID_0000002,20140501,0,0,
42001,account_test0003,ORDER_ID_0000003,20140701,0,0,CardholderName
29000,3
90003,3
会員ID紐付結果CSVファイル
元取引IDと会員IDを紐付けての会員登録およびカード登録結果のCSVファイルのフォーマットを以下に記載します。
ファイル名 | 依頼ファイル名 + ".result" | 形式 | CSVファイル |
---|---|---|---|
文字コード | Shift-JIS | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/linkaccount/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "10003"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
2 行目 | ||||
レコード種別 | - | - | ○ | "21000"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "42001"固定 旧バージョンは"42000"固定 |
結果ステータス | 半角数字 | 1 | ○ | "0":成功, "1":失敗 |
会員ID | 半角英数字 | 100 | ○ | 消費者を一意に識別するID。以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク) |
取引ID | 半角英数字 | 100 | ○ | 元取引ID |
入会年月日 | 半角数字 | 8 | 登録された入会年月日(YYYYMMDD形式) | |
標準カードフラグ | 半角数字 | 1 | 登録された標準カードフラグ | |
洗替対象フラグ | 半角数字 | 1 | 登録された洗替対象フラグ | |
カードID | 半角英数字 | 100 | 公開カードID | |
マスクカード番号 | 半角数字 | 16 | マスクカード番号 | |
有効期限 | 半角英数字 右記参照 | 5 | カード有効期限(MM/YY (月 + "/" + 年)の形式 (例 "08/")) マスクされずに返戻されます。 |
|
結果メッセージ | 文字列 | 100 | 失敗の場合は結果メッセージ | |
カード保有者名 | 半角英数字記号 | 2~45 | 登録されたカード保有者名 マスクされずに返戻されます。 この項目は2022年6月に追加されました。旧バージョンにはありません。 |
|
最終行-1行 | ||||
レコード種別 | - | - | ○ | "29000"固定 |
マーチャント毎データ件数 | 半角数字 | 8 | ○ | 店舗様毎の会員ID紐付依頼データ件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータの件数 |
エラーデータ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータ件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "90003"固定 |
データ総件数 | 半角数字 | 8 | ○ | 会員ID紐付依頼データの総件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータのトータル件数 |
エラーデータ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータトータル件数 |
【会員ID紐付結果CSVファイルのサンプル(linkaccount A10000000000000xxxxxxx.csv.result)】
10003,0
21000,A10000000000000106XXXX
42001,0,account_test0001,ORDER_ID_0000001,20141231,1,1,7SJRWD61PQUHWPF222WTJZYHO,4XXXXX********XX,11/15,,
42001,1,account_test0002,ORDER_ID_0000002,,,,,,,取引IDからカード情報を取得できませんでした。,
42001,1,account_test0003,ORDER_ID_0000003,,1,0,,,11/15,退会済みの会員です。退会日:2010/05/01,CardholderName
29000,3,1,2
90003,3,1,2
継続課金登録
継続課金情報の登録は、「会員情報登録CSVファイル」または「決済登録依頼CSVファイル」にて行います。どちらも登録済みの会員IDに対して継続課金情報を登録することが可能です。「会員情報登録CSVファイル」の場合は標準カードが継続課金で使用するカードになり、「決済登録依頼CSVファイル」の場合は、継続課金で使用するカードをカードIDで指定することが可能です。詳細は、「4.1.1 会員登録CSVファイル」、「4.4.1 決済登録依頼CSVファイル」を参照してください。
継続課金処理の結果は、「継続課金結果CSVファイル」にてお知らせします。詳細は、「4.3.1 継続課金結果CSVファイル」を参照してください。
継続課金結果CSVファイル
継続課金結果のCSVファイルのフォーマットを以下に記載します。
ファイル名 |
課金グループID + "_" + YYYYMMDD + ".set" ※「YYYYMMDD」は、継続課金の処理日です。(例えば毎月10日に継続課金する課金グループで2017年8月の継続課金結果ファイルの場合は、20170810となります。) |
形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/recurring/result |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | 10006(固定) |
データ種別 | 半角数字 | 1 | ○ | "0":本番 |
2 行目 | ||||
レコード種別 | - | - | ○ | 21000(固定) |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | a2000(固定) |
会員ID | 半角英数字 | 100 | ○ | 課金対象となる消費者の会員ID 以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク) |
取引ID | 半角英数字 | 100 | ○ | 決済サーバーにて付与された取引ID(採番規則は以下の通りです) マーチャントID + "_" + 課金グループID + "_" + システムにて採番された数値 + "_" YYYYMMDD + "_" + 決済サーバーにて採番された連番 |
課金グループID | 半角英数字 | 50 | ○ | 課金したスケジュールの課金グループID 以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア) |
課金日付 | 半角数字 | 8 | ○ | 課金された日付(YYYYMMDD形式) |
課金額 | 半角数字 | 8 | ○ | 課金金額 |
要求売上日 | 半角数字 | 8 | 売上要求された日付(YYYYMMDD形式) | |
メモ1 | 文字列 | 100 | 取引に関するメモ情報 | |
メモ2 | 文字列 | 100 | 取引に関するメモ情報 | |
メモ3 | 文字列 | 100 | 取引に関するメモ情報 | |
キー情報 | 半角英数字 | 256 | RECURRING(固定) | |
結果コード | 半角英数字 | 4 | ○ | 会員管理処理結果の結果コード |
結果メッセージ | 文字列 | - | ○ | 会員管理処理結果のメッセージ |
決済結果コード | 半角英数字 | 16 | ○ | 決済処理結果の結果コード |
決済結果メッセージ | 文字列 | - | ○ | 決済処理結果のメッセージ |
最終行-1行 | ||||
レコード種別 | - | - | ○ | 29000(固定) |
データ件数 | 半角数字 | 8 | ○ | 課金データ件数 |
決済成功データ件数 | 半角数字 | 8 | ○ | 決済が正常に完了したデータの件数 |
決済エラーデータ件数 | 半角数字 | 8 | ○ | 決済が失敗したデータ件 |
最終行 | ||||
レコード種別 | - | - | ○ | 90006(固定) |
データ件数 | 半角数字 | 8 | ○ | 課金データ件数 |
決済成功データ件数 | 半角数字 | 8 | ○ | 決済が正常に完了したデータの件数 |
決済エラーデータ件数 | 半角数字 | 8 | ○ | 決済が失敗したデータ件 |
【継続課金結果CSVファイルのサンプル(A10000000000000xxxxxxx_DEFAULT_20160415.set)】
10006,0
21000,A10000000000000xxxxxxx
a2000,account-1460444283606,A10000000000000xxxxxxx_DEFAULT_1728_1460707229576_0000001,DEFAULT,20160415,20,20160229,,,,RECURRING,X001,処理が成功しました。,A001000000000000,処理が成功しました。
a2000,account-1460444289896,A10000000000000xxxxxxx_DEFAULT_1728_1460707229587_0000002,DEFAULT,20160415,20,20160229,,,,RECURRING,X001,処理が成功しました。,A001000000000000,処理が成功しました。
a2000,account-1460444295237,A10000000000000xxxxxxx_DEFAULT_1728_1460707229602_0000003,DEFAULT,20160415,20,20160330,めもめもめも121,めもめもめも221,めもめもめも321,RECURRING,X001,処理が成功しました。,A001000000000000,処理が成功しました。
a2000,account-1460444300467,A10000000000000xxxxxxx_DEFAULT_1728_1460707229608_0000004,DEFAULT,20160415,20,20160330,めもめもめも122,めもめもめも222,めもめもめも322,RECURRING,X001,処理が成功しました。,A001000000000000,処理が成功しました。
29000,4,4,0
90006,4,4,0
決済登録
「4.4.1 決済登録依頼CSVファイル」にフォーマットエラーがない場合は、レコードが処理され、「4.4.2 決済登録結果CSVファイル」が出力されます。決済結果を確認し、処理失敗となっているレコードについては適宜対応してください。
「4.4.1 決済登録依頼CSVファイル」にフォーマットエラーがある場合は、レコードが処理されず、「4.7.2 エラーCSVファイル(会員ID紐付、決済登録)」が出力されます。CSVファイルを修正し、再度アップロードしてください
決済登録依頼CSVファイル
決済登録を依頼する際に使用するCSVファイルのフォーマットを以下に記載します。
ファイル名 | 半角英数字のみで任意(記号不可) | 形式 | CSVファイル |
---|---|---|---|
文字コード | Shift-JIS | 改行コード | CRLF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/settlement/in |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "10001"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
2 行目 | ||||
レコード種別 | - | - | ○ | "21000"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目 | ||||
レコード種別 | - | - | ○ | "31007"固定 旧バージョンは"31001"固定 |
4 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "32007"固定 旧バージョンは"32001"固定 |
サービスコマンド | 半角英数字 | 15 | ○ |
"Authorize" :与信 "ReAuthorize" :再与信 "Capture" :売上 "Cancel" :キャンセル ※"Capture"は与信取得済みの取引に対する売上処理になります。与信と売上を同時に行う場合は、サービスコマンドは"Authorize"を設定し、売上フラグを"true"に設定してください。 |
取引ID | 半角英数字 | 100 | ○ | オーダーID "-"(ハイフン)、"_"(アンダースコア)も使用可能 |
元取引ID | 半角英数字 | 100 | 再取引を行う過去取引のオーダーID | |
金額 | 半角数字 | 8 | 1以上99999999以下 | |
カード番号 | 半角数字 | 16 | カード番号 ハイフン含みの場合は19桁 |
|
カード有効期限 | 半角英数字 右記参照 |
5 | カード有効期限(MM/YY (月 + "/" + 年)の形式 (例 "08/")) | |
JPO支払情報 | 半角英数字 | 8 | 2桁以上8桁以下の半角英数字、 下記を設定可能 一括払い : 10 または 空白 分割払い : 61Cxx (xx :分割回数) ボーナス払い : 21 リボルビング払い : 80 |
|
売上フラグ | 半角英字 | 10 |
"true":与信同時売上 "false":与信のみ ※未設定時は"false"が設定される |
|
会員ID | 半角英数字 | 100 | 取引に紐付ける会員 ID "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 |
|
カードID | 半角英数字 | 100 | 会員管理で管理しているカード情報を決済で利用する場合に指定 | |
標準カードフラグ | 半角数字 | 1 |
今後、決済時にカード情報をリクエスト含めなかった場合に、今回の決済で使用したカード情報を使用するか否かを設定 "1":今回のカードを今後決済時使用するカードに設定 "0":この課金でのみ利用する。 ※未設定時は"1"が設定される |
|
課金グループID | 半角英数字 | 50 | 継続課金対象の課金グループID 事前に登録済みの課金グループIDのみ指定可能 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)も使用可能 |
|
課金開始日 | 半角数字 | 8 |
課金を開始する日付(YYYYMMDD形式)
※初回課金される日付ではありません。 |
|
課金終了日 | 半角数字 | 8 |
課金を終了する日付(YYYYMMDD形式)
※最後に課金される日付ではありません。 |
|
都度/初回課金金額 | 半角数字 | 8 | 都度課金時、または継続課金時の初回の課金金額 都度課金の場合は、次回課金時の金額を指定 継続課金の場合は、課金グループにて指定している金額とは異なる金額で決済したい場合に設定 |
|
継続課金金額 | 半角数字 | 8 | 継続課金時、2回目以降の決済金額 課金グループで指定した金額とは異なる金額で決済したい場合に設定 |
|
取引メモ1 | 半角英数字 | 50 | 取引に関するメモ情報 | |
キー情報 | 半角英数字 | 256 | 取引に関するキー情報 店舗様で別途管理しているIDとこちらの取引を紐付けるためのキー情報を設定可 (例:店舗様側システムの受注番号と、取引を紐付ける) |
|
カード保有者名 | 半角英数字記号 | 2~45 |
カード保有者名
この項目は2022年6月に追加されました。旧バージョンにはありません。 |
|
最終行-2行 | ||||
レコード種別 | - | - | ○ |
"39007"固定
旧バージョンは"39001"固定 |
データ件数 | 半角数字 | 8 | ○ | 決済登録データ件数 |
最終行-1行 | ||||
レコード種別 | - | - | ○ | "29000"固定 |
マーチャント毎データ件数 | 半角数字 | 8 | ○ | 店舗様毎の決済登録データ件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "90001"固定 |
データ総件数 | 半角数字 | 8 | ○ | 決済登録データの総件数 |
CSVファイルによる決済は、決済サーバーのAPIをバッチ処理で呼び出すためのインターフェースとなっており、各パラメータの設定仕様は、決済サーバーのAPIの仕様に従います。APIの仕様については、「VeriTrans4G インターフェース詳細~クレジットカード決済~」をご確認ください。
会員ID(既存)、元取引ID、カード番号・有効期限が同時に設定されている場合は、使用されるカード情報の優先順位は次のとおりです。
- カード番号・有効期限で設定された情報
- 会員に紐付いたカード情報
- 元取引で使用されたカード情報
カードの登録は、決済で使用されたカード情報が未登録であった場合に、登録されます。
CSV設定の組み合わせによって、決済に使用されるカード情報、カード登録は以下のようになります。
設定 | 決済 | 登録 | ||||
---|---|---|---|---|---|---|
会員ID | カード番号 有効期限 | 元取引ID | 決済に使用される情報 | 決済 結果 | 会員 登録 | 登録されるカード情報 |
未登録ID | 決済されない | - | × | × | ||
未登録ID | ○ | 設定されたカード情報 | 成功 | ○ | 設定されたカード情報 | |
失敗 | × | × | ||||
未登録ID | ○ | 元取引IDに紐づいたカード情報 | 成功 | ○ | 元取引IDに紐づいたカード情報 | |
失敗 | × | × | ||||
未登録ID | ○ | ○ | 設定されたカード情報 | 成功 | ○ | 設定されたカード情報 |
失敗 | × | × | ||||
既存ID | 会員IDに紐づいたカード情報 | - | - | - | ||
既存ID | ○ | 設定されたカード情報 | 成功 | - | 設定されたカードが未登録の場合、登録される | |
失敗 | - | × | ||||
既存ID | ○ | 会員IDに紐づいたカード情報 | - | - | - | |
既存ID | ○ | ○ | 設定されたカード情報 | 成功 | - | 設定されたカードが未登録の場合、登録される |
失敗 | - | × | ||||
○ | 設定されたカード情報 | |||||
○ | 元取引IDに紐づいたカード情報 | |||||
○ | ○ | 設定されたカード情報 |
※グレーのセルの組み合わせは動作保証しておりませんので、使用しないでください。
※「設定」列の空欄は、未設定(設定されていないこと)を示します。
※CSV作成時には、以下の点に注意してください。
【決済登録依頼CSVファイルのサンプル(settlement A10000000000000xxxxxxx.csv)】
10001,0
21000,A10000000000000106XXXX
31007
32007,Authorize,sampleTestOrderID-001,,800,4111111111111111,12/24,,false,,,,,,,,,memo-001,,CARDHOLDERNAME
32007,Capture,sampleTestOrderID-001,,800,,,,,,,,,,,,,memo-002,,
32007,Authorize,sampleTestOrderID-003,,800,4111111111111111,12/24,,false,,,,,,,,,memo-003,,
32007,Cancel,sampleTestOrderID-003,,800,,,,,,,,,,,,,memo-004,,
32007,Authorize,sampleTestOrderID-005,,800,4111111111111111,12/24,,false,,,,,,,,,memo-005,,
32007,ReAuthorize,sampleTestOrderID-006,sampleTestOrderID-005,800,4111111111111111,12/24,,false,,,,,,,,,memo-006,,
39007,6
29000,6
90001,6
【決済登録依頼CSVファイルの登録パターン別必須項目】
会員IDで決済 | 会員ID指定して決済と課金グループ登録 | 再取引で決済 | 売上 | キャンセル | |
---|---|---|---|---|---|
レコード種別 | ○ | ○ | ○ | ○ | ○ |
サービスコマンド | Authorize | Authorize | ReAuthorize | Captuer | Cancel |
取引ID | ○ | ○ | ○ | ○ | ○ |
元取引ID | × | × | ○ | × | × |
金額 | ○ | ○ | ○ | ○ | △ |
カード番号 | × | × | × | × | × |
カード有効期限 | × | × | × | × | × |
JPO支払情報 | △ | △ | △ | × | × |
売上フラグ | △ | △ | △ | × | × |
会員ID | ○ | ○ | × | × | × |
カードID | △ | △※1 | × | × | × |
標準カードフラグ | △ | △ | × | × | × |
課金グループID | × | ○ | × | × | × |
課金開始日 | × | △ | × | × | × |
課金終了日 | × | △ | × | × | × |
都度/初回課金金額 | × | △ | × | × | × |
継続課金金額 | × | △ | × | × | × |
取引メモ1 | △ | △ | △ | △※ | △※ |
キー情報 | △ | △ | △ | △※ | △※ |
カード保有者名 | △ | △ | × | × | × |
必須項目:○ 任意項目:△ 設定不可:×
※1 カードIDが未設定の場合は課金グループは標準カードに紐づきます。
※取引メモ、キー情報は、最後に設定した内容で更新されます。詳しくは『開発ガイド』をご参照ください。
決済登録結果CSVファイル
決済登録結果のCSVファイルのフォーマットを以下に記載します。
ファイル名 | 依頼ファイル名 + ".result" | 形式 | CSVファイル |
---|---|---|---|
文字コード | Shift-JIS | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/settlement/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "10001"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
2 行目 | ||||
レコード種別 | - | - | ○ | "21000"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目 | ||||
レコード種別 | - | - | ○ | "31007"固定 |
4 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "32007"固定 |
処理結果コード | 半角英数字 | 32 | ○ | "success":正常終了 "failure":異常終了 "pending":保留 |
詳細結果コード | 文字列 | 16 | ○ | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 |
エラーメッセージ | 文字列 | 100 | ○ | 処理結果を日本語で表示します。 |
電文ID | 文字列 | 100 | ○ | 決済サーバーが決済処理電文(内部処理も含む)毎に付与するID 1つの取引IDに対して、複数のIDが付与されます。 |
取引ID | 文字列 | 100 | ○ | 決済要求時に店舗様にて任意に採番し送信された取引ID |
取引毎に付くID | 文字列 | 100 | ○ | 決済サーバーがオーダー(取引ID)と紐付ける為に採番するID |
MDK バージョン | 半角英数字 | 5 | ○ | 電文のバージョン |
カードトランザクションタイプ | 文字列 | 6 | ||
ゲートウェイ要求日時 | 文字列 | 14 | ゲートウェイが要求電文を受け取った日時 YYYYMMDDhhmmss形式 |
|
ゲートウェイ応答日時 | 文字列 | 14 | ゲートウェイが応答電文を返した日時 YYYYMMDDhhmmss形式 |
|
センター要求日時 | 文字列 | 14 | カード決済センターが要求電文を受取った日時 YYYYMMDDhhmmss形式 |
|
センター応答日時 | 文字列 | 14 | カード決済センターが応答電文を返した日時 YYYYMMDDhhmmss形式 |
|
ペンディング | 文字列 | 1 | "0":なし "1":あり | |
ループバック | 文字列 | 1 | "0":なし "1":あり | |
接続先カード接続センター | 文字列 | 5 | 決済サーバー⇒カード会社間の接続センター名 'jcn' |
|
センター要求番号 | 文字列 | 7 | ||
センターリファレンス番号 | 文字列 | 7 | ||
要求カード番号 | 文字列 | 16 | 要求電文に設定した値 上6桁下2桁のみ数字表示され、その他は "*"(アスタリスク)に変換されます。(例 "411111********11") |
|
要求カード有効期限 | 文字列 | 5 | 要求電文に設定した値 全桁"*"(アスタリスク)に変換されます。(例 "*****") |
|
要求取引金額 | 文字列 | 12 |
要求電文に設定した値
※Cancelで決済金額を指定しない場合は、全額が設定されます。 |
|
要求仕向け先コード | 文字列 | 2 | 仕向け先コード(acquirerCode)と同一の値 | |
要求支払種別情報 | 文字列 | 83 | 要求電文に設定した値 | |
要求同時売上 | 文字列 | 5 | 要求電文に設定した値 | |
応答リターン参照番号 | 文字列 | 12 | カード会社との通信時にシステム内部で利用する番号 | |
応答承認番号 | 半角英数字 | 7 | カード会社が発行する承認番号 | |
アクションコード | 文字列 | 3 | カード会社との通信時に返戻されたコード値 | |
応答センターエラーコード | 文字列 | 3 | カード会社における結果コード (例 "G12") | |
応答与信期間 | 文字列 | 3 | ||
仕向け先コード | 文字列 | 2 | 店舗が加盟店契約をしているカード会社のコード 最終的に決済を行うカード発行会社ではなく、決済要求電文が最初に仕向けられる加盟店管理会社です。 |
|
会員管理処理番号 | 半角英数字 | 20 | 会員管理処理要求を一意に識別する番号 | |
会員管理ステータス | 半角英数字 | 20 | 会員管理処理要求の実行結果 "success":成功 "failure":失敗 |
|
会員管理メッセージ | 文字列 | 100 | 会員管理処理要求の実行結果メッセージ | |
会員ID | 半角英数字 | 100 | "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 | |
カードID | 半角英数字 | 100 | 決済サーバーにて付与されたカードID | |
マスクカード番号 | 半角数字 | 16 | カード番号の上6桁下2桁のみ数字表示され、その他は"*"(アスタリスク)に変換されます。(例 "411111********11") | |
カード有効期限 | 半角英数字 右記参照 |
5 | カード有効期限(MM/YY (月 + "/" + 年)の形式 (例 "08/")) マスクされずに返戻されます。 |
|
標準カードフラグ | 半角数字 | 1 |
今後、決済時にカード情報をリクエスト含めなかった場合に、今回の決済で使用したカード情報を使用するか否かを設定 "1":今回のカードを今後決済時使用するカードに設定する。 "0":この課金でのみ利用する。 ※未設定時は"1"が設定される |
|
課金グループID | 半角英数字 | 50 | 継続課金対象の課金グループID "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)も使用可能 |
|
カード保有者名 | 半角英数字記号 | 2~45 | 要求電文に設定した値 | |
最終行-2行 | ||||
レコード種別 | - | - | ○ | "39007"固定 |
データ件数 | 半角数字 | 8 | ○ | 決済登録データ件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータ件数 |
エラーデータ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータ件数 |
最終行-1行 | ||||
レコード種別 | - | - | ○ | "29000"固定 |
マーチャント毎データ件数 | 半角数字 | 8 | ○ | 店舗様毎の決済登録データ件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータ件数 |
エラーデータ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータ件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "90001"固定 |
データ総件数 | 半角数字 | 8 | ○ | 決済登録データ総件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータ件数 |
エラーデータ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータ件数 |
【決済登録結果CSVファイルのサンプル(settlement A10000000000000xxxxxxx.csv.result)】
10001,0
21000,A10000000000000106XXXX
31007
32007,success,A001H00100000000,処理が成功しました。,129483,sampleTestOrderID-001,129483,2.0.0,a,20141125145854,20141125145854,20141125145854,20141125145854,0,0,,,,411111********11,*****,800,05,,false,012345678901,000000,000, ,,05,,,,,,,12/24,,,CARDHOLDERNAME
32007,success,A001000000000000,処理が成功しました。,129487,sampleTestOrderID-001,129483,2.0.0,pa,20141125145914,20141125145914,,,0,0,,,,,,800,05,,,,000000,, ,,05,,,,,,,,,,
32007,success,A001H00100000000,処理が成功しました。,129484,sampleTestOrderID-003,129484,2.0.0,a,20141125145854,20141125145854,20141125145854,20141125145854,0,0,,,,411111********11,*****,800,05,,false,012345678901,000000,000, ,,05,,,,,,,12/24,,,
32007,success,A001000000000000,処理が成功しました。,129488,sampleTestOrderID-003,129484,2.0.0,va,20141125145924,20141125145924,20141125145924,20141125145924,0,0,,,,,,800,05,,,012345678901,000000,000, ,,05,,,,,,,,,,
32007,success,A001H00100000000,処理が成功しました。,129485,sampleTestOrderID-005,129485,2.0.0,a,20141125145855,20141125145855,20141125145855,20141125145855,0,0,,,,411111********11,*****,800,05,,false,012345678901,000000,000, ,,05,,,,,,,12/24,,,
32007,success,A001H00100000000,処理が成功しました。,129486,sampleTestOrderID-006,129486,2.0.0,a,20141125145904,20141125145904,20141125145904,20141125145904,0,0,,,,411111********11,*****,800,05,,false,012345678901,000000,000, ,,05,,,,,,,12/24,,,
39007,6,6,0
29000,6,6,0
90001,6,6,0
洗替対象クレジットカード情報登録
洗替結果CSVファイル
洗替結果CSVファイルのフォーマットを以下に記載します。
※2015年01月以降の仕様です。旧仕様についてはお問い合わせください。
ファイル名 |
"id_" + "MID"+ "_" + "YYYYMMDD" + ".cardcleaning" ※「ストアした情報」とは、決済サーバーにて保持している会員IDに紐付いた情報です。 |
形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/cardcleaning/result |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
洗替依頼日時 | 半角英数字 | 14 | ○ | 洗替処理を依頼した日時 YYYYMMDDhhmmss形式 |
2 行目 | ||||
レコード種別 | - | - | ○ | "head_cardcleaning"固定 |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "data_cardcleaning"固定 |
店舗管理ID | - | - | 常に空で返戻されます。 | |
店舗管理備考 | - | - | 常に空で返戻されます。 | |
カード番号 | 半角数字 | 16 | ○ |
カード番号
※カード番号の先頭6桁と下2桁のみ数字表示され、その他は "*"(アスタリスク)に変換されます。(例"411111********11") |
有効期限 | 半角英数字 右記参照 |
5 | ○ | カード有効期限(MM/YY (月 + "/" + 年)の形式 (例 "08/")) |
会員ID | 半角英数字 | 100 |
会員ID 以下の文字を含む場合もあります。 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク) ※洗替結果ファイル出力までに退会した会員の場合、空で返戻される場合があります。 |
|
新カード番号 | 半角数字 | 16 |
新カード番号(更新時のみ設定)
※カード番号の先頭6桁と下2桁のみ数字表示され、その他は "*"(アスタリスク)に変換されます。(例"411111********11") |
|
新有効期限 | 半角英数字 右記参照 |
5 | 新有効期限(更新時のみ設定) (MM/YY (月 + "/" + 年)の形式 (例 "08/")) |
|
有効性判定結果 | 半角数字 | 1 | ○ | 有効性判定結果 "0":有効、 "1":無効、 "2":照合エラー 「4.5.2 洗替の有効性判定結果について」を参照 |
カードID | 半角英数字 | 100 | 決済サーバーにて付与したカード情報を特定するためのID | |
最終行 | ||||
レコード種別 | - | - | ○ | "footer_cardcleaning"固定 |
データ件数 | 半角数字 | 8 | ○ | 洗替依頼データ件数 |
【洗替結果CSVファイルのサンプル(id_A10000000000000xxxxxxx_20150805.cardcleaning)】
head_merchant,A10000000000000xxxxxxx,YYYYMMDDhhmmss
head_cardcleaning
data_cardcleaning,,,411111********11,08/14,account001,,,0,CARDID001
data_cardcleaning,,,411111********11,01/16,account002,,,0,CARDID002
data_cardcleaning,,,411111********11,01/16,account003,,,0,CARDID003
data_cardcleaning,,,411111********11,01/16,account004,,,0,CARDID004
data_cardcleaning,,,411111********11,01/16,account005,,,0,CARDID005
footer_cardcleaning,5
洗替の有効性判定結果について
洗替の「有効性判定結果」は6種類あります。
有効性判定結果 | 説明 | |
---|---|---|
0 | 有効 | 有効なクレジットカード |
1 | 無効 | 無効なクレジットカード(詳細理由の開示は不可) |
2 | 照合エラー | カード会社システムでの照合エラー(該当のクレジットカードが確認できない等。詳細理由の開示は不可) |
3 | 仕向先なし | 仕向先が判断出来ない場合や弊社が対応していないカード会社の発行カード |
4 | 洗替対象外 | 加盟店様の洗替契約の対象外のカード |
5 | 結果データなし | 有効性判定期間中に該当する会員のカードが削除される、または、カード会社から結果が返戻されない |
- 0:有効、 1:無効、 2:照合エラー は、カード会社から返戻された有効性判定結果になります。
- 3:仕向先なし、 4:洗替対象外、 5:結果データなし は、弊社で判定した結果です。
- 3:仕向先なし、 4:洗替対象外 については、カード会社に洗替依頼を出すことができないカードになります。
洗替結果ファイルとMAPの「洗替検索結果」では、出力(表示内容)が異なります。下表に出力の有無を示します。
有効性判定結果 | 洗替結果CSVファイル | MAPの「洗替結果検索」 |
---|---|---|
0:有効 | ○ | ○ |
1:無効 | ○ | ○ |
2:照合エラー | ○ | ○ |
3:仕向先なし | ×(出力されない) | ○ |
4:洗替対象外 | ×(出力されない) | ○ |
5:洗替データなし | ×(出力されない) | ○ |
有効性判定結果が1:無効、2:照合エラー となったカードは、洗替対象から外されます。ただし、カード情報を変更するか、そのカードで決済を行いますと、再度、洗替対象となります。
会員IDコピー
「4.6.1 会員IDコピー依頼CSVファイル」にフォーマットエラーがない場合は、レコードが処理され、「4.6.2 会員IDコピー結果CSVファイル」が出力されます。
「4.6.1 会員IDコピー依頼CSVファイル」にフォーマットエラーがある場合は、レコードが処理されず、「4.7.3 エラーCSVファイル(会員IDコピー)」が出力されます。CSVファイルを修正し、再度アップロードしてください。
1つの会員IDに対して複数の元会員IDをコピーした場合、最後にコピーした元会員IDの標準カードがコピー先の会員IDの標準カードになりますが、ファイル処理は、マルチスレッドで処理していますので、必ずしもファイルの記載順で処理されるわけではありません。そのため、標準カードにしたいレコードは、別ファイルにして、最後に処理するようにしてください。
会員IDコピー依頼CSVファイル
会員IDコピーに使用するファイルのフォーマットを以下に記載します。
ファイル名 | 半角英数字のみで任意(記号不可) | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/copyaccount/in |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "head_account"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード
※本番モード(本番アカウントにてデータ種別を"0")を利用する際、元会員IDを本番モードで作成している必要があります。コピー先の会員IDは本番会員として登録されます。 ※ダミーモード(テストアカウントを利用、または本番アカウントにてデータ種別を"1")を利用する際、元会員IDをダミーモードで作成している必要があります。コピー先の会員IDはダミー会員として登録されます。 |
ファイルフォーマットバージョン | 半角数字 | 5 | ○ | "V0002"固定 ※今後ファイルフォーマットが変更になる場合は、設定値を変更する。 |
2 行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "data_account" 固定 |
加盟店使用欄 | 半角英数字 | 10 | 指定した値がそのまま結果ファイルに出力されます。 通常、依頼ファイルと結果ファイルの行は一致(依頼ファイルのN行目のデータは結果ファイルのN行目に出力)しますが、加盟店様にて、依頼ファイルと結果ファイルのレコードを紐づけるために利用することができます。 なお、ファイル内でのユニーク性のチェックは行われません。 |
|
会員ID | 半角英数字 | 100 | ○ | コピー先の会員IDを指定 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能 |
元会員ID | 半角英数字 | 100 | ○ | コピー元の会員IDを指定 "."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)も使用可能。 |
入会年月日 | 半角数字 | 8 | YYYYMMDD形式。会員登録時に未指定の場合、当日日付が設定されます。 | |
退会年月日 | 半角数字 | 8 |
元会員ID退会フラグを設定した場合の元会員IDに対する操作の指定となります。 YYYYMMDD形式。会員退会時に未指定の場合、当日日付が設定されます。 |
|
強制退会フラグ | 半角数字 | 1 |
元会員ID退会フラグを設定した場合の元会員IDに対する操作の指定となります。 継続課金中であっても強制的に退会するか否か指定するフラグ"0":継続課金中の場合、退会できない。 "1":強制的に終了する。(以降課金は継続課金は発生しない。) ※未設定時は"0"が設定されます。 |
|
カード情報削除フラグ | 半角数字 | 1 |
元会員ID退会フラグを設定した場合の元会員IDに対する操作の指定となります。 退会時にクレジットカード情報を削除するか否か指定するフラグ"0":クレジットカード情報を削除しない。 "1":クレジットカード情報を削除する。 ※未設定時は"0"が設定されます。 |
|
元会員ID退会フラグ | 半角数字 | 1 |
複製時に元会員を退会するか否か指定するフラグ "0":元会員を退会しない。 "1":元会員を退会する。 ※未設定時は"0"が設定されます。 |
|
カード情報追加フラグ | 半角数字 | 1 |
会員IDで指定したコピー先となる会員IDが既に存在する場合に、既存の会員IDにカード情報を追加するか否か指定するフラグ "0":カード情報を追加しない。 "1":カード情報を追加する。 ※未設定時は"0"が設定されます。 |
|
標準カード限定フラグ | 半角数字 | 1 |
複製時に標準カードのみ追加するか否か指定するフラグ "0":元会員に紐づく全てのカード情報を追加する。 "1":元会員に紐づく標準カードのみ追加する。 ※未設定時は"0"が設定されます。 |
|
洗替設定フラグ | 半角数字 | 1 |
複製先のカード情報を洗替するか否か指定するフラグ "0":洗替しない。 "1":洗替する。
※未設定時は"1"が設定されます。 |
|
最終行-1行 | ||||
レコード種別 | - | - | ○ | "footer_merchant"固定 |
処理件数 | 半角数字 | 8 | ○ | マーチャント毎の入力データの件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "footer_account"固定 |
処理件数 | 半角数字 | 8 | ○ | 入力データ件数 |
【会員IDコピー依頼CSVファイルのサンプル(accountCopyA10000000000000xxxxxxx.csv)】
head_account,0,V0002
head_merchant,A10000000000000XXXXXXX
data_account,kameiten1,account1,originalaccount1,20190514,20190515,0,0,0,0,0,0
data_account,kameiten2,account2,originalaccount2,20190516,20190517,0,0,0,0,0,0
data_account,kameiten3,account3,originalaccount3,20190518,20190519,0,0,0,1,1,1
footer_merchant,3
footer_account,3
会員IDコピー結果CSVファイル
会員IDコピー結果CSVファイルのフォーマットを以下に記載します。
ファイル名 | 会員IDコピー依頼ファイル名 + ".result" | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | /マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/copyaccount/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "head_account"固定 |
データ種別 | 半角数字 | 1 | ○ | "0":本番、"1":ダミーモード |
ファイルフォーマットバージョン | 半角数字 | 5 | ○ | "V0002"固定 ※今後ファイルフォーマットが変更になる場合は、設定値を変更する。 |
2 行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
3 行目以降データ件数分 | ||||
レコード種別 | - | - | ○ | "data_account"固定 |
加盟店使用欄 | 半角英数字 | 10 | 依頼ファイルに指定した値 | |
詳細結果コード | 文字列 | 16 | ○ | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は別途VResultCodeListを参照して下さい。 |
会員管理ステータス | 半角英数字 | 20 | ○ | "success":成功、"failure":失敗 |
会員管理メッセージ | 文字列 | 100 | ○ | 会員管理処理要求の実行結果メッセージ |
会員ID | 半角英数字 | 100 | ※1 | 依頼ファイルで指定した会員ID |
カードID | 半角英数字 | 100 | ※1、2 | 決済サーバにて付与されたカードIDが返戻されます。 標準カードのカードIDが返戻されます。 |
マスクカード番号 | 半角数字 | 16 | ※1、2 | カード番号の先頭6桁と下2桁(例"411111********11")のみ数字表記され、その他は "*"(アスタリスク)に変換されます。ハイフンは含まれません。 |
有効期限 | 半角数字 | 5 | ※1、2 | MM/YY形式。マスクされずに返戻されます。 |
標準カードフラグ | 半角数字 | 1 | ※1、2 | カード情報を指定せず決済する場合に使用するカードか否かを示すフラグ "0":決済時、カード情報を明示的に指定しない場合に使用されるカードではない "1":決済時、カード情報を明示的に指定しない場合に使用されるカード ※本機能では"1"固定で返戻されます。 |
元カードID | 半角数字 | 100 | ※1、2 | 元会員IDに紐づいていたカードIDが返戻されます。 元々、会員IDに紐づいていたカード情報の場合は返戻されません。 |
券種コード | 半角英数字 | 10 | ※1、2 | 券種を判定するコード ※ベリトランス決済サーバに判定用のBINとコード値を設定しておく必要がございます。詳細につきましてはお問い合わせください。 |
カード件数 | 半角数字 | 7 | ※1 | 会員IDに紐づいているカードの件数 例)会員IDにA、B、Cのカードが紐づいている場合、「3」が返戻されます。 |
カード保有者名 | 半角英数字記号 | 2~45 |
会員のカードに紐づいているカード保有者名 マスクされずに返戻されます。 この項目はファイルフォーマットバージョン「V0002」で追加されました。 |
|
最終行-1行 | ||||
レコード種別 | - | - | ○ | "footer_merchant"固定 |
処理件数 | 半角数字 | 8 | ○ | マーチャント毎の出力データの総件数 |
成功データ件数 | 半角数字 | 8 | ○ | マーチャント毎の登録が成功したデータの件数 |
失敗データ件数 | 半角数字 | 8 | ○ | マーチャント毎の登録が失敗したデータの件数 |
最終行 | ||||
レコード種別 | - | - | ○ | "footer_account "固定 |
処理件数 | 半角数字 | 8 | ○ | 出力データの総件数 |
成功データ件数 | 半角数字 | 8 | ○ | 登録が成功したデータの総件数 |
失敗データ件数 | 半角数字 | 8 | ○ | 登録が失敗したデータの総件数 |
※1 会員管理ステータスが"success"の場合のみ返戻されます。
※2 標準カード情報が返戻されます。会員IDに標準カードが紐づいていない場合、値は設定されません。
【会員IDコピー結果CSVファイルのサンプル(accountCopyA10000000000000xxxxxxx.result)】
head_account,0,V0002
head_merchant,A10000000000000XXXXXXX
data_account,kameiten1,X001000000000000,success,処理が成功しました。,account1,ABCDEFGHIJ,411111******1111,05/14,1,BCDEFGHIJKL,A1000,3,
data_account,kameiten2,XH07000000000000,failure,未登録の会員です。,account2,,,,,,,,
data_account,kameiten3,X001000000000000,success,処理が成功しました。,account3,CDE123FGHI,411111******1111,05/18,1,ABCDEFGHIJK,A1000,1,CardholderName
footer_merchant,3,2,1
footer_account,3,2,1
共通
会員情報登録にて、ファイルの受付後、取り込み処理中にエラーになった場合は、以下の共通したエラーファイルが生成されます。
エラーCSVファイルのフォーマットを以下に記載します。
ファイル名 | 受信ファイル名 + ".error" | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | 会員情報登録:/マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/account/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | "head_merchant"固定 |
マーチャントID | 半角英数字 | 22 | ○ | 店舗様を一意に識別するID |
2 行目 | ||||
結果コード | 半角英数字 | 4 | ○ | エラー原因を表す結果コード |
結果メッセージ | 文字列 | - | ○ | エラーメッセージ |
3 行目以降データ件数分 | ||||
行番号 | 半角数字 | - | ○ | エラーが発生したデータの行番号(データ行内の番号ではなく、依頼ファイルの行番号) |
結果コード | 半角英数字 | 4 | ○ | その行のデータに対する結果コード |
結果メッセージ | 文字列 | - | ○ | その行のデータに対する結果メッセージ |
【会員登録依頼CSVファイルでエラーが発生したと想定した場合のサンプル】
以下の会員登録依頼CSVファイルをアップロード(accountA10000000000000xxxxxxx.csv)
head_merchant,A10000000000000xxxxxxx
head_account,1
data_account,DEFAULT_F0000001,4111111111111111,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000002,5555555555554444,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000003,5105105105105100,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000004,5500000000000004,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000005,3528000000000007,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000006,3528000000000015,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000007,3528000000000023,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000008,3530111333300000,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000009,378282246310005,06/14,1,DEFAULT,1,,,,,,,1
data_account,DEFAULT_F0000010,36666666666660,06/14,1,DEFAULT,1,,,,,,,1
footer_account,10
上記のaccountA10000000000000xxxxxxx.csvを取り込み中にエラーが発生した場合、以下のエラーファイルが生成されます。
head_merchant,A10000000000000xxxxxxx
XH86,受付データチェックエラーです。ファイル名:accountA10000000000000xxxxxxx.csv
3,XH11,入会中の会員です。
4,XH11,入会中の会員です。
エラーCSVファイル(会員ID紐付、決済登録)
会員ID紐付、決済登録にて、ファイルの受付後、取り込み処理中にエラーになった場合は、以下の共通したエラーファイルが生成されます。
エラーCSVファイルのフォーマットを以下に記載します。
ファイル名 | 受信ファイル名 + ".error" | 形式 | CSVファイル |
---|---|---|---|
文字コード | shift-JIS | 改行コード | LF |
ファイル配置先 | 会員ID紐付:/マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/linkaccount/out 決済登録:/マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/settlement/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1行目 | ||||
レコード種別 | - | - | ○ |
決済登録の場合:80001 会員ID紐づけの場合:80003 |
2行目 | ||||
行番号 | 半角数字 | - | ○ | 行番号(データ行内の番号ではなく、依頼ファイルの行番号) |
結果コード | 半角英数字 | 4 | ○ | 結果コード |
結果メッセージ | 半角英数字 | 100 | ○ | 結果メッセージ |
3行目 | ||||
レコード種別 | - | - | ○ |
決済登録の場合:90001 会員ID紐づけの場合:90003 |
【会員ID紐付依頼CSVファイルでエラーが発生したと想定した場合のサンプル】
以下の会員ID紐付依頼CSVファイルをアップロード(linkaccount A10000000000000xxxxxxx.csv)
10003,0
21000,A10000000000000106XXXX
42000,account_test0001,ORDER_ID_0000001,,,
42000,account_test0002,ORDER_ID_0000002,20140501,0,
42000,account_test0003,ORDER_ID_0000003,20140701,0,0
29000,3
90003,3
上記のlinkaccount A10000000000000xxxxxxx.csvを取り込み中にエラーが発生した場合、以下のエラーファイルが生成されます。
80003
2,XC01,パラメータは必須項目です。:レコード種別
90003
エラーCSVファイル(会員IDコピー)
会員IDコピーにて、ファイルの受付後、取り込み処理中にエラーになった場合は、以下の共通したエラーファイルが生成されます。
エラーCSVファイルのフォーマットを以下に記載します。
ファイル名 | 受信ファイル名 + ".error" | 形式 | CSVファイル |
---|---|---|---|
文字コード | UTF-8(BOMなし) | 改行コード | LF |
ファイル配置先 | 会員IDコピー:/マーチャントIDの下2桁/マーチャントIDの下8桁(先頭はアルファベットに変換)/copyaccount/out |
項目名 | 書式 | サイズ | 必須 | 説明 |
---|---|---|---|---|
1 行目 | ||||
レコード種別 | - | - | ○ | 80004 |
2 行目 | ||||
行番号 | 半角数字 | - | ○ | 行番号(データ行内の番号ではなく、依頼ファイルの行番号) |
結果コード | 半角英数字 | 4 | ○ | 結果コード |
結果メッセージ | 半角英数字 | 100 | ○ | 結果メッセージ |
3 行目 | ||||
レコード種別 | - | - | ○ | 90004 |
【会員IDコピー依頼CSVファイルでエラーが発生したと想定した場合のサンプル】
以下の会員ID紐付依頼CSVファイルをアップロード(copyaccount A10000000000000xxxxxxx.csv)
head_account,0,V0001
A10000000000000xxxxxxx
data_account,kameiten1,accountId-new,accountId-old,,,,,0,0,0,0
footer_merchant,1
footer_account,1
上記のcopyaccount A10000000000000xxxxxxx.csvを取り込み中にエラーが発生した場合、以下のエラーファイルが生成されます。
80004
2,XC04,パラメータ値の形式が不正です。:レコード種別
90004