一括決済サービス(会員ID版)ファイル仕様
概要
一括決済サービス(会員ID版)は、登録済みの会員カード情報を使用して複数の決済を一括処理する機能です。
以下の流れでファイル処理が進みます。
- SFTP
- 管理画面
処理の流れ(SFTP):
- 加盟店様が準備:複数の決済データを CSV/TXT で作成
- ファイルをアップロード:SFTP でアップロードファイルと OK ファイルを送信
- システムが取込検証:ファイル形式の検証と仮登録を実施 → 取込結果ファイルで通知
- 決済を実行:仮登録されたデータを基に実際の決済処理 → 売上結果ファイルで返却
処理の流れ(管理画面):
- 加盟店様が準備:複数の決済データを CSV/TXT で作成
- ファイルをアップロード:管理画面でアップロードファイルのみ送信
- システムが取込検証:ファイル形式の検証を実施(通知なし)
- 決済を実行:登録されたデータを基に実際の決済処理 → 売上結果ファイルで返却
- 事前に会員登録とカード情報登録が完了している必要があります
- SFTPサーバーを利用する場合は、SFTPファイル連携の流れを参照してください
ファイル形式と仕様
アップロードファイル
SFTPサーバーへアップロードする場合、以下の2つのファイルを配置してください:
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル(完了通知ファイル)
格納イメージ:
ホームディレクトリ
├ bulk_m_v1_0000000000001_20211105_01.txt.gz
└ bulk_m_v1_0000000000001_20211105_01.txt.gz.ok
命名規則
- SFTP
- 管理画面
bulk_m_v1_[ショップID]_[処理指定日YYYYMMDD]_[通番].[拡張子]
| 項目 | 説明 | 例 |
|---|---|---|
| モード | ファイルモードを表す識別子 | m_v1(会員ID版) |
| ショップID | 加盟店様のショップID | shopid0000001 |
| 処理指定日 | 決済を実行する日付(YYYYMMDD) | 20220831 |
| 通番 | 同日の再アップロード時にカウントアップ | 01, 02, ... |
同じ処理指定日に再アップロードする場合、通番を01→02→03...とカウントアップしてください。
ファイル名に制限はありません
ファイル名は任意の名称を指定できます。
拡張子
.txt.gzまたは.csv.gz(SFTP).txtまたは.csv(管理画面)
SFTP では、.txt または .csvをgzip形式で圧縮します。
管理画面 では、圧縮せずにアップロードしてください。
OK ファイル
- SFTP
- 管理画面
アップロードファイルの送信完了を示すために、アップロードファイル名に.okを付与したファイルを送信します。ファイルの中身は空です。
例:ショップID
0000000000001で2021年11月5日処理指定の場合
bulk_m_v1_0000000000001_20211105_01.txt.gz
bulk_m_v1_0000000000001_20211105_01.txt.gz.ok
OK ファイルは、アップロード処理の完了をシステムに知らせるシグナルです。アップロードファイルと同時に送信してください。
OK ファイルのアップロードは不要です。アップロードファイルのみで処理が開始されます。
ファイル仕様
基本フォーマット
- 区切り文字:
,(カンマ) - 項目の括り:全項目を
"(ダブルクォート)で括る - 改行コード:CRLF推奨(LFでアップロードした場合もCRLFで返却されます)
| No | 項目名 | 桁数 | 必須 | 説明 |
|---|---|---|---|---|
| 1 | ショップID | 13 | ✔ | 加盟店様を識別するID 当サービス契約時に発行される値 |
| 2 | オーダーID | 27 | ✔ | 加盟店様が取引を識別するためのID オーソリ処理にて、指定したオーダーIDが利用されます。 他機能も含め必ずユニークな値にしてください。 半角英数字、 -(ハイフン)が利用可能です。 |
| 3 | 商品コード | 7 | 通常は省略してください。 カード会社との間の契約にて使用する商品コードが決められた場合のみ設定してください。 (省略した際は、 0000990を使用して処理します。) | |
| 4 | 利用金額 | 7 | ✔ | 商品・サービスに対する金額 税送料を指定していない場合は、決済金額です。 税送料を指定している場合は、利用金額+税送料が決済金額です。 |
| 5 | 税送料 | 7 | 商品とは異なる送料等の金額 税送料が利用金額に含まれる場合、値の設定は不要です。 | |
| 6 | 会員ID | 60 | ✔ | 決済を行う会員のID 半角英数字+一部半角記号( - @ _ .)が使用可能です。 |
| 7 | カード登録連番 | 4 | 対象となるカードの登録連番 ※物理モードの値です。 ※省略時にはデフォルトフラグを参照します。 | |
| 8 | 加盟店自由項目1 | 100 | 加盟店様が自由に使用できる項目 半角英数記号( ^ ` { | } ~ & < > " ' 除く)と全角文字が使用可能です。桁は全角文字が含まれない場合の上限です。 | |
| 9 | 加盟店自由項目2 | 100 | 同上 | |
| 10 | 加盟店自由項目3 | 100 | 同上 | |
| 11 | 未使用 | 2 | ""固定 |
必須記号
- ✔:必須
- 空白:省略可能
取込結果ファイル
SFTP でのみ、ファイル取込後の検証結果が結果ファイルで通知されます。
管理画面 からのアップロードでは、ファイル取込結果の通知はありません。
ホームディレクトリからファイルをGETしてください。
取込結果ファイルは、以下の2つのファイルが配置されます:
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル(完了通知ファイル)
格納イメージ:
ホームディレクトリ
├ Ibulk_m_v1_0000000000001_20211105_01.txt.gz
└ Ibulk_m_v1_0000000000001_20211105_01.txt.gz.ok
取込結果ファイルの取得が完了したら、原則としてSFTPサーバーから削除してください。
命名規則
I + (アップロードファイル名).[拡張子]
OK ファイル
I + (ファイル名) + .ok
例:
bulk_m_v1_0000000000001_20211105_01.txt.gzをアップロードした場合
Ibulk_m_v1_0000000000001_20211105_01.txt.gz
Ibulk_m_v1_0000000000001_20211105_01.txt.gz.ok
ファイル仕様
基本フォーマット
- 区切り文字:
,(カンマ) - 項目の括り:全項目を
"(ダブルクォート)で括る - 改行コード:CRLF
| No | 項目名 | 桁数 | 説明 |
|---|---|---|---|
| 1 | レコード通番 | 7 | アップロードファイルでの行番号 |
| 2 | エラーコード | 3 | 発生したエラーコード 取込に失敗した場合に設定されます。 |
| 3 | エラー詳細コード | 9 | 発生したエラー詳細コード 取込に失敗した場合に設定されます。 |
売上結果ファイル
ホームディレクトリからファイルをGETしてください。
売上結果ファイルは、以下の2つのファイルが配置されます:
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル(完了通知ファイル)
格納イメージ:
ホームディレクトリ
├ Rbulk_m_v1_0000000000001_20211105_01.txt.gz
└ Rbulk_m_v1_0000000000001_20211105_01.txt.gz.ok
売上結果ファイルの取得が完了したら、原則としてSFTPサーバーから削除してください。
命名規則
R + (アップロードファイル名).[拡張子]
OK ファイル
R + (ファイル名) + .ok
※通番は01固定です。
例:
bulk_m_v1_0000000000001_20211105_01.txt.gzをアップロードした場合
Rbulk_m_v1_0000000000001_20211105_01.txt.gz
Rbulk_m_v1_0000000000001_20211105_01.txt.gz.ok
ファイル仕様
基本フォーマット
- 区切り文字:
,(カンマ) - 項目の括り:全項目を
"(ダブルクォート)で括る - 改行コード:CRLF
| No | 項目名 | 桁数 | 説明 |
|---|---|---|---|
| 1 | ショップID | 13 | アップロード時に指定した値 |
| 2 | オーダーID | 27 | アップロード時に指定した値 |
| 3 | 商品コード | 7 | アップロード時に指定した値 |
| 4 | 利用金額 | 7 | アップロード時に指定した値 |
| 5 | 税送料 | 7 | アップロード時に指定した値 |
| 6 | 会員ID | 60 | アップロード時に指定した値 |
| 7 | カード登録連番 | 4 | アップロード時に指定した値 |
| 8 | 加盟店自由項目1 | 100 | アップロード時に指定した値 |
| 9 | 加盟店自由項目2 | 100 | アップロード時に指定した値 |
| 10 | 加盟店自由項目3 | 100 | アップロード時に指定した値 |
| 11 | 未使用 | 2 | ""固定 |
| 12 | 処理結果 | 11 | 処理結果のステータスREGISTER:登録成功PAYSUCCESS:決済完了INVALID:登録失敗PAYFAIL:決済失敗DISABLED:無効済み |
| 13 | 取引ID | 32 | 当サービスが取引を識別するためのID |
| 14 | 取引パスワード | 32 | 当サービスが取引を識別するためのパスワード |
| 15 | トランザクションID | 28 | 当サービスホスト機にて付番された決済の処理通番 |
| 16 | 承認番号 | 7 | カード会社にて付番された決済の承認番号 |
| 17 | 仕向先コード | 7 | データを送信したカード会社コード |
| 18 | エラーコード | 3 | 発生したエラーコード |
| 19 | エラー詳細コード | 9 | 発生したエラー詳細コード |
| 20 | 処理日時 | 14 | 処理を行った日付 書式は、 yyyymmddhhmmss形式です。 |
| 21 | レコード通番 | 7 | アップロードファイルでの行番号 |
処理結果が登録成功(REGISTER)の場合、No.13~No.19はブランクです。
注意事項
一括決済サービス(会員ID版)を安全に運用するために、以下の制約事項と対応方法を必ずご確認ください。
カード情報の反映タイミング
会員IDに紐づくカード情報はファイル取込時点の情報が使用されます。
対応方法
| タイミング | 反映状況 | 対応方法 |
|---|---|---|
| ファイル取込前にカード情報更新 | ✔ 反映される | そのまま処理可能 |
| ファイル取込後にカード情報更新 | ✖ 反映されない | ファイルを再アップロード |
更新後のカード情報で課金する場合の手順
- 会員のカード情報を更新
- 更新完了を確認
- 売上依頼ファイルを再作成
- ファイルを再アップロード
ファイル管理とセキュリティ
取込結果ファイルおよび売上結果ファイルの取得が完了したら、必ずSFTPサーバーから削除してください。