移行パターンA ファイル仕様
概要
移行パターンAは、既存の洗替・継続課金サービスから移行する際に、従来のファイル形式を維持したまま利用できる互換モードです。
以下の流れでファイル処理が進みます。
- SFTP
- 管理画面
処理の流れ（SFTP）：
- 加盟店様が準備：複数の決済データを CSV/TXT で作成
- ファイルをアップロード：SFTP でアップロードファイルと OK ファイルを送信
- システムが取込検証：ファイル形式の検証と仮登録を実施 → 取込結果ファイルで通知
- 決済を実行：仮登録されたデータを基に実際の決済処理 → 売上結果ファイルで返却
処理の流れ（管理画面）：
- 加盟店様が準備：複数の決済データを CSV/TXT で作成
- ファイルをアップロード：管理画面でアップロードファイルのみ送信
- システムが取込検証：ファイル形式の検証を実施（通知なし）
- 決済を実行：登録されたデータを基に実際の決済処理 → 売上結果ファイルで返却
- SFTPサーバーを利用する場合は、SFTPファイル連携の流れを参照してください
ファイル形式と仕様
アップロードファイル
SFTPサーバーへアップロードする場合、以下の2つのファイルを配置してください：
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル（完了通知ファイル）
格納イメージ：
ホームディレクトリ
├ bulk_m_uri_0000000000001_20211105_01.txt.gz
└ bulk_m_uri_0000000000001_20211105_01.txt.gz.ok
命名規則
- SFTP
- 管理画面
bulk_m_uri_[ショップID]_[処理指定日YYYYMMDD]_[通番].[拡張子]
| 項目 | 説明 | 例 |
|---|---|---|
| モード | ファイルモードを表す識別子 | m_uri（移行パターンA） |
| ショップ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_uri_0000000000001_20211105_01.txt.gz
bulk_m_uri_0000000000001_20211105_01.txt.gz.ok
OK ファイルは、アップロード処理の完了をシステムに知らせるシグナルです。アップロードファイルと同時に送信してください。
OK ファイルのアップロードは不要です。アップロードファイルのみで処理が開始されます。
ファイル仕様
基本フォーマット
- 区切り文字：
,（カンマ） - 項目の括り：全項目を
"（ダブルクォート）で括る - 改行コード：CRLF推奨（LFでアップロードした場合もCRLFで返却されます）
| No | 項目名 | 桁数 | 必須 | 説明 |
|---|---|---|---|---|
| 1 | ショップID | 13 | ✔ | 加盟店様を識別するID 当サービス契約時に発行される値 |
| 2 | 会員ID | 60 | ✔ | 決済を行う会員のID 半角英数字＋一部半角記号（ - @ _ .）が使用可能です。 |
| 3 | カード登録連番 | 4 | 対象となるカードの登録連番 ※物理モードの値です。 ※省略時にはデフォルトフラグを参照します。 | |
| 4 | 取引コード | 1 | 通常は省略してください。 処理を識別するコード 設定する際は 0（売上）のみ使用可能です。 | |
| 5 | 未使用 | - | ""固定 | |
| 6 | オーダーID | 27 | ✔ | 加盟店様が取引を識別するためのID オーソリ処理にて、指定したオーダーIDが利用されます。 他機能も含め必ずユニークな値にしてください。 半角英数字、 -（ハイフン）が利用可能です。 |
| 7 | 商品コード | 7 | 通常は省略してください。 カード会社との間の契約にて使用する商品コードが決められた場合のみ設定してください。 （省略した際は、 0000990を使用して処理します。） | |
| 8 | 利用金額 | 7 | ✔ | 商品・サービスに対する金額 税送料を指定していない場合は、決済金額です。 税送料を指定している場合は、利用金額＋税送料が決済金額です。 |
| 9 | 税送料 | 7 | 商品とは異なる送料等の金額 税送料が利用金額に含まれる場合、値の設定は不要です。 | |
| 10 | 支払方法 | 1 | 通常は省略してください。 設定する際は 1（一括払い）のみ設定可能です。 | |
| 11 | 未使用 | - | ""固定 | |
| 12 | 未使用 | - | ""固定 | |
| 13 | 未使用 | - | ""固定 | |
| 14 | 端末処理通番 | 5 | 加盟店様が自由に使用できる項目 数字のみ使用可能です。 | |
| 15 | 加盟店自由項目 | 100 | 加盟店様が自由に使用できる項目 半角英数記号（ ^ ` { | } ~ & < > " ' 除く）と全角文字が使用可能です。桁は全角文字が含まれない場合の上限です。 | |
| 16 | 処理番号 | - | 結果用項目""固定 | |
| 17 | 処理結果 | - | 結果用項目""固定 | |
| 18 | 仕向先コード | - | 結果用項目""固定 | |
| 19 | オーソリ結果 | - | 結果用項目""固定 |
必須記号
- ✔：必須
- 空白：省略可能
取込結果ファイル
SFTP でのみ、ファイル取込後の検証結果が結果ファイルで通知されます。
管理画面 からのアップロードでは、ファイル取込結果の通知はありません。
ホームディレクトリからファイルをGETしてください。
取込結果ファイルは、以下の2つのファイルが配置されます：
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル（完了通知ファイル）
格納イメージ：
ホームディレクトリ
├ Ibulk_m_uri_0000000000001_20211105_01.txt.gz
└ Ibulk_m_uri_0000000000001_20211105_01.txt.gz.ok
取込結果ファイルの取得が完了したら、原則としてSFTPサーバーから削除してください。
命名規則
I + (アップロードファイル名).[拡張子]
OK ファイル
I + (ファイル名) + .ok
例：
bulk_m_uri_0000000000001_20211105_01.txt.gzをアップロードした場合
Ibulk_m_uri_0000000000001_20211105_01.txt.gz
Ibulk_m_uri_0000000000001_20211105_01.txt.gz.ok
ファイル仕様
基本フォーマット
- 区切り文字：
,（カンマ） - 項目の括り：全項目を
"（ダブルクォート）で括る - 改行コード：CRLF
| No | 項目名 | 桁数 | 説明 |
|---|---|---|---|
| 1 | レコード通番 | 7 | アップロードファイルでの行番号 |
| 2 | エラーコード | 3 | 発生したエラーコード 取込に失敗した場合に設定されます。 |
| 3 | エラー詳細コード | 9 | 発生したエラー詳細コード 取込に失敗した場合に設定されます。 |
売上結果ファイル
ホームディレクトリからファイルをGETしてください。
売上結果ファイルは、以下の2つのファイルが配置されます：
- 後述の命名規則により命名された、データファイル
- 配置完了を表す OK ファイル（完了通知ファイル）
格納イメージ：
ホームディレクトリ
├ Rbulk_m_uri_0000000000001_20211105_01.txt.gz
└ Rbulk_m_uri_0000000000001_20211105_01.txt.gz.ok
売上結果ファイルの取得が完了したら、原則としてSFTPサーバーから削除してください。
命名規則
R + (アップロードファイル名).[拡張子]
OK ファイル
R + (ファイル名) + .ok
※通番は01固定です。
例：
bulk_m_uri_0000000000001_20211105_01.txt.gzをアップロードした場合
Rbulk_m_uri_0000000000001_20211105_01.txt.gz
Rbulk_m_uri_0000000000001_20211105_01.txt.gz.ok
ファイル仕様
基本フォーマット
- 区切り文字：
,（カンマ） - 項目の括り：全項目を
"（ダブルクォート）で括る - 改行コード：CRLF
| No | 項目名 | 桁数 | 説明 |
|---|---|---|---|
| 1 | ショップID | 13 | アップロード時に指定した値 |
| 2 | 会員ID | 60 | アップロード時に指定した値 |
| 3 | カード登録連番 | 4 | アップロード時に指定した値 |
| 4 | 取引コード | 1 | アップロード時に指定した値 |
| 5 | 利用年月日 | 8 | 処理指定日が設定されます。 |
| 6 | オーダーID | 27 | アップロード時に指定した値 |
| 7 | 商品コード | 7 | アップロード時に指定した値 |
| 8 | 利用金額 | 7 | アップロード時に指定した値 |
| 9 | 税送料 | 7 | アップロード時に指定した値 空の場合は 0を設定します。 |
| 10 | 支払方法 | 1 | 1が設定されます。 |
| 11 | 予備 | - | ""固定 |
| 12 | 予備 | - | ""固定 |
| 13 | 予備 | - | ""固定 |
| 14 | 端末処理通番 | 5 | アップロード時に指定した値 |
| 15 | 加盟店自由項目 | 50 | アップロード時に指定した値 |
| 16 | 処理番号 | - | システム側で自動採番された値 |
| 17 | 処理結果 | - | 売上（返品を含む）処理結果 ※「無効なレコード」についてはブランクです。 0：成功（該当レコードの売上（返品）がカード会社へ送信されました）1：アップロード時のエラー（フォーマットエラー・会員IDに対して有効なカードが存在しない場合等）2：オーソリ時のエラー（オーソリ時にエラーが発生）3：売上処理時のエラー（イレギュラーケースのみ。例：カード登録時の仕向先との加盟店契約を解除した場合等） |
| 18 | 仕向先コード | - | データを送信したカード会社のコード |
| 19 | オーソリ結果 | - | オーソリを実施した際に以下のいずれかが返却されます。000000000：オーソリOKエラーコード：オーソリNG |
注意事項
移行パターンAを安全に運用するために、以下の制約事項と対応方法を必ずご確認ください。
カード情報の反映タイミング
会員IDに紐づくカード情報は、ファイル取込時点の情報が使用されます。ファイル取込後にカード情報を更新しても、処理には反映されません。
対応方法
更新後のカード情報で決済を実施する場合は、以下の手順で対応してください。
- 既にアップロード済みのファイルを無効化（該当する場合）
- 会員のカード情報を更新
- 新しいカード情報でファイルを再アップロード
- 取込結果ファイルで正常に取り込まれたことを確認
ファイル管理とセキュリティ
取込結果ファイルおよび売上結果ファイルの取得が完了したら、必ずSFTPサーバーから削除してください。