| v4.11 | リリース |
| v5.4 | 「1-1. GMOペイメントゲートウェイマスターの作成」に項目「支払完了とするステータス・支払受付完了とするステータス」を追加 見出し2, 3に「結果通知プログラム利用時」を追加 |
本記事では、GMOペイメントゲートウェイとの連携方法について説明します。
1.事前設定
1-1.GMOペイメントゲートウェイマスターの作成
GMOペイメントゲートウェイ(GMOPG)と連携してオンライン決済を行うために必要な接続情報を設定します。
また、GMOから通知される取引状態のうち、どの値を「支払完了」・「支払受付完了」とみなすかを設定します。
| 項目名 | 説明 |
|---|---|
| 設定ID | 決済画面のデザインや動作を定義した設定の単位 |
| 注文番号プレフィックス | GMOPGの注文ID(オーダーID)に設定する番号のプレフィックス (プレフィックス+10桁の自動採番) ※ 使用できる文字は英数字とハイフン(-)のみ |
| ショップID | 加盟店を一意に識別するID |
| ショップパスワード | API接続時に使用するパスワード |
| 戻り先URL | 支払完了やキャンセルなどすべてのケースで遷移するURL |
| 完了時戻り先URL | 支払いが完了した場合のみ遷移するURL ※ 戻り先URLは必ず未設定 |
| キャンセル時戻り先URL | キャンセル操作を行った場合のみ遷移するURL ※ 戻り先URLは必ず未設定 |
| 支払完了とするステータス* | GMOから通知される取引状態の内、「支払完了」として扱う値 申請ステータスマスターの「支払完了」アクションに従って申請ステータスが更新 ※ 詳細は 3. 申請ステータスの自動更新 を参照 |
| 支払受付完了とするステータス* | GMOから通知される取引状態の内、「支払受付完了」として扱う値 申請ステータスマスターの「支払受付完了」アクションに従って申請ステータスが更新 ※ 詳細は 3. 申請ステータスの自動更新 を参照 |
| テスト環境 | テスト環境のショップ情報を使用する場合は必ずtrue |
1-2.支払いページの作成
GMOPGのリンクタイプPlus決済ページへ遷移するために、「paymentStartButton」コンポーネントを配置したページを作成します。
「paymentStartButton」コンポーネントにあるボタンは、GMOペイメントゲートウェイ取引の「取引状態」項目の値によってボタンが変化します。
- 取引状態が「URL発行」 → 「支払いへ進む」ボタン
- 上記以外 → 「支払い状況を確認する」ボタン
1-2-1.内部ユーザー用ページの作成手順
- 設定 > Lightningアプリケーションビルダー で[新規]ボタンを押下します。
- 「アプリケーションページ」を選択し、表示ラベルを設定します。
- 「Lightning ページを新規作成」で任意のレイアウトを選択し、[完了]を押下します。
- 「paymentStartButton」コンポーネントをページ上にドラッグ&ドロップで配置し、[保存]を押下します。
- [有効化]を押下しページのタブを作成します。この際、タブアイコンの変更が可能です。
1-2-2.外部ユーザー用ページの作成手順
Experience Cloud サイトで申請時に遷移するページを作成します。
- エクスペリエンスビルダーを開き、「新規ページ」を選択します。
- 「標準ページ」を選択して「新しい空白のページ」を選択します。
- 任意のレイアウトを選択し、名前・URL・API参照名を設定します。
- 「Lightningページを新規作成」の画面で任意のレイアウトを選択し、[完了]を押下します。
- 「paymentStartButton」コンポーネントを「コンテンツ」エリア上にドラッグ&ドロップして配置します。
1-3.フォームテンプレートの設定
1-3-1.指定遷移先の設定
申請確定後に支払いページに遷移するための設定をします。
- 設定 > オブジェクトマネージャー > 「フォームテンプレート」 を選択します。
- 「項目とリレーション」 で「指定遷移先」を選択します。
- 選択リスト値を新規追加します。
- 内部ユーザー用ページ(Lightningページ)
作成したページのタブ名が「PaymentPage」であれば、以下の値を追加します。
-,PaymentPage,standard__navItemPage,,{recordId}タブ名は 設定 > タブ で該当のタブを選択し「タブ名」を確認します。
- 外部ユーザー用ページ(コミュニティサイト)
コミュニティサイトのページAPI参照名が「PaymentPage__c」としていれば、以下の値を追加します。
-,PaymentPage__c,comm__namedPage,,{recordId}ページのAPI参照名はビルダー画面から該当ページのページプロパティから確認します。
1-3-2.GMOペイメントゲートウェイマスターと指定遷移先をセット
「GMOペイメントゲートウェイマスター」と「指定遷移先」をフォームテンプレートにセットします。
1-3-3.金額入力欄の設定
決済ページに支払い金額として連携される入力欄を指定します。
入力欄の型を「数値」とし、支払い連携セクションにある「金額項目として使用する」にチェックを入れます。
この設定は1つのフォームテンプレート内で必ず1つにしてください。
2.取引状態の自動更新
GMO決済画面で「戻り先URL」または「完了時戻り先URL」に遷移した際、GMOペイメントゲートウェイ取引の「取引状態」項目は以下のように自動で更新されます。
- クレジットカード等の即時決済:「支払完了」
- コンビニ決済やPay-easy(ペイジー)等の非同期決済で支払い情報の入力が完了:「支払受付完了」
※ 非同期決済系では決済完了の検知が不可能であるため、取引状態が自動更新されません。
そのため、「GMO結果通知プログラム」の利用を推奨します。
- GMO結果通知プログラム利用時
取引状態は上記とは異なり、決済手段によって変わります。
各決済手段の取引状態とその内容について、詳細は 各決済手段 の概要ページを参照してください。
3. 申請ステータスの自動更新
取引状態が「支払完了」または「支払受付完了」のいずれかに変更された際、申請ステータスマスターの設定に従って申請ステータスの自動更新が可能です。
申請ステータスマスターの「アクション」が「支払完了」・「支払受付完了」のレコードを必ず用意してください。
- GMO結果通知プログラム利用時
v5.4からGMOペイメントゲートウェイマスターに追加された「支払完了とするステータス」と「支払受付完了とするステータス」の項目を利用します。
これらの項目でセットされてる値にGMOペイメントゲートウェイ取引の「取引状態」が更新された際、申請ステータスマスターの「支払完了」、「支払受付完了」のアクションに従って申請ステータスが更新されます。
- 取引状態は各決済手段により取りうる値が異なります。値については 各決済手段 の概要ページを参照してください。
- 申請ステータスマスターについてはリファレンス記事 申請ステータスマスター を参照してください。
4.注意事項
- コンビニ決済やPay-easy(ペイジー)等の非同期決済では決済完了を検知できません。
現在の決済状況についてはショップ管理画面からご確認ください。 - v5.4からGMO結果通知プログラム機能を利用することで、非同期決済における決済状況の変化を検知可能です。
詳細は GMO結果通知プログラム を参照してください。 - ゲスト申請ではご利用いただけません。