payモジュールの基本設定
概要
payモジュールは、user、entry、formモジュールと連携して決済機能を構築できます。
決済形態は、都度支払いの「都度決済」と、サブスクリプション型の「継続決済」の選択が可能です。
これにより、会員制サイトやイベント申込ページなどに柔軟な決済オプションを追加できます。
- userモジュール：有料会員限定のクローズドサイトを運営
- entryモジュール：有料イベントや講習会の申込ページで決済
- formモジュール：有料プラン申し込み時に決済を導入
基本機能
payモジュールの主な機能は次のとおりです：
- 決済形態：都度決済、継続決済
- 決済方法：クレジットカード、銀行振込、代金引換 ※クレジットカード決済は SBペイメントサービス との契約が必要です。
- 適用税率：標準税率・軽減税率の個別適用可
- メール機能：注文や決済時に自動メール送信
- フロント側ページ：注文一覧・詳細、決済一覧、注文編集ページ作成可
決済形態や税率設定は、連携先のモジュール（user/entry/form）内の登録コンテンツで記述します。
👉 payモジュール連携時のコンテンツの作成方法
payモジュールの操作権限（ロール）
| 権限 | 登録 | 一覧 | 詳細 | 編集 | 削除 | 備考 |
|---|---|---|---|---|---|---|
| 一般 | ○ | - | - | - | - | |
| ユーザー | ○ | ○ | - | △ | - | 継続停止、決済方法の変更可 |
| 管理者 | - | ○ | ○ | △ | ○ | 継続停止・ステータス変更が可能 |
※2021年10月4日現在、マネージャー権限には操作権限がありません。
payモジュールの構築
モジュール導入からWebコンテンツ作成までの大まかな流れは以下になります。
「payシート」は、対象モジュール（user、entry、formモジュール）の決済管理を行います。
- 決済方法設定：payモジュールで利用する決済方法を定義
- シート新規作成：決済機能を付加する対象モジュールを指定し、新規payシートを作成
- シート編集：payアクションが発生した場合のメールアドレスを設定
- メニュー作成：作成したpayシートをサイドメニューに表示
- アクセス権限（ロール）設定：各権限によるpayモジュールの操作権限を設定
- ステータス設定：「仮売上」「本決済」などの決済ステータスを作成
- ステータス連携：決済方法と決済ステータスを連携
- 決済動作設定：pay対象シートに決済が行われた際の動作設定を定義（任意）
1. 決済方法管理設定
まず、payモジュール共通となる決済方法の設定を行います。後で各々のpayシートに必要な決済方法を紐づけます。
歯車マーク > pay | 決済方法管理 を選択し、「新規作成」より基本情報を設定します。
基本情報
| 項目 | 内容 |
|---|---|
| 決済方法名 | 決済方法の名称を設定します。※コンテンツ側で決済方法の表示名称として使用されます。 |
| 決済種別 | クレジットカード決済（SBペイメントサービス）/ 自由定義から設定。 ・クレジットカード決済の登録は1件のみ。 ・「自由定義」は「代引き」「銀行振込」などその他を設定。 |
クレジット決済をご利用の場合は、SBペイメントサービスから提供された各種情報の入力が必要です。
- お客様情報：マーチャントID、サービスID
- 接続先情報：ハッシュキー、3DES 暗号化キー、3DES初期化キー、API接続先URL、トークンサービス接続先URL
決済方法一覧 > 鉛筆アイコン から編集します。
2. シート新規作成
歯車マーク > シート設定 | モジュール から、**pay「シート作成」**を選択します。
対象情報
| 項目 | 内容 |
|---|---|
| 対象モジュール | user / entry / formから選択 |
| 対象シート | 決済機能の対象シートを設定 |
共通設定
| 項目 | 内容 |
|---|---|
| 注文名称 | 注文情報の名称（例：サブスク会員決済、講習会申込決済など） |
| 決済名称 | 決済情報の名称 |
| 決済方法 | 利用する決済方法を選択（※無効のものは使用不可） |
payモジュールは「注文情報の中に決済情報を持つ」構成です。 商品情報（pay_item）は user / entry / form によって定義されます。
3. シート編集
「共通設定」以外に、シート編集より検索表示やメールアドレスなどの追加設定があります。
追加設定項目
| カテゴリ | 項目 | 内容 |
|---|---|---|
| 管理者設定 | 検索項目表示設定 | payシート一覧画面における検索項目の表示 / 非表示を制御 |
| ソート項目 | ID / 継続決済予定日 / 注文日時 | |
| ソート順 | 昇順 / 降順 | |
| メール配信設定 | メールアドレス設定 | 通知先メールアドレスを設定（自動配信メール管理：payモジュール） |
4. メニュー作成
メニュー設定 を行い、サイドバーに表示設定します。
5. アクセス権限（ロール）設定
対象シートとpayモジュールに対して、アクセス権限を設定します。
6. ステータス設定
注文情報の「決済ステータス」を管理します。 デフォルトは「仮売上」「本決済」「キャンセル」。
「無効」「有効」の動作設定があります。作成した選択肢名に動作設定を紐づけます。
例：保留 → 無効 or 有効のどちらかを選択
7. ステータス連携
決済方法と決済ステータスを連携。
ステータス連携について
「クレジットカード決済」という方法に「仮売上(0)」などの挙動を定義します。
- 仮売上（0）、本決済（1）、キャンセル（2） を定義
- 初期値設定で挙動を変える（即時本決済 or 与信確認後に本決済）
※カード会社からパレットCMSへの通知はありません。
8. 決済動作設定
payシート > 各種設定 | 決済動作設定 より設定します。
活用例
- 有料会員登録時にポイントを付与
- 「仮売上」→「本決済」になった際に特定ステータスを付与
基本情報
| 項目 | 内容 |
|---|---|
| 変更前ステータス | ステータス変更前の値を指定 |
| 変更後ステータス | ステータス変更後の値を指定 |
| 詳細条件 | 条件を細かく指定（最大10件、順番に実行） |
変更内容
| 項目 | 内容 |
|---|---|
| 対象項目 | 対象シートの項目 |
| 動作種別 | 置換 / 加算 / 減算（整数 or 小数点） |
| 設定値 | 選択肢名 / 数値（対象に応じて） |
ステータス設定
| 項目 | 内容 |
|---|---|
| ステータス | 有効 / 無効 |
詳細条件の設定内容
条件対象を選択すると、左辺条件が選択可能になります。
- 決済額が×××円なら会員ランクを○○ランクにする。
- 注文した商品合計が×××円以上で、会員に○○ポイントを付与（加算）する。
- 会員の有効期限を決済日の○日後に設定する。
| 条件対象 | 左辺条件 | 比較演算子 | 右辺条件 |
|---|---|---|---|
| 決済 | 決済額 登録日時 | ＝ != ≦（以前） ?（より前） ≧（以降） ?（より後） | 任意の設定値 |
| 注文 | 注文種別 継続状態 商品合計金額 商品合計金額（初回） | 任意の設定値 | |
| 対象（注文の対象情報） | pay対象シートの任意項目 ※文字列１行、数値、小数点、日付、ラジオ、プルダウン項目 | 任意の設定値 |
左辺条件の値が空の場合（pay対象シートの任意項目が必須入力ではなく、値が入っていないケース）は、条件がスキップされます。
決済動作の実行順序について
詳細条件を組み合わせることにより、1つの基本条件に対して複数の条件が設定できます。
動作の実行は、決済動作一覧の上部リストから順に実行されます。
想定どおり動作しない場合は、条件設定と共に、リストの並び順も確認してください。
並び順の変更は、リスト左端のアイコンをドラッグして操作します
コンテンツ作成
payモジュールには、以下のコンテンツがあります。
- payモジュール連携時のコンテンツの作成方法（ユーザー・エントリー・フォーム登録）
決済を行うエントリー登録や会員登録コンテンツを作成します。 - 注文一覧 注文情報の一覧コンテンツです。
- 注文詳細 注文詳細のコンテンツです。
- 決済一覧 決済情報の一覧コンテンツです。
- 注文編集 決済方法の変更、継続決済の停止をすることができるコンテンツです。