リダイレクトの構成方法

概要

ユーザーが支払いを完了した後に別のページにリダイレクトするには、パブリッシャーアカウントまたはAPI経由でリダイレクトを設定できます。さまざまな支払いステータス(支払い完了またはキャンセル)に対して、次のリダイレクトを構成できます:

  • 自動 — 設定された遅延時間でリダイレクトされます。
  • 手動 — ユーザーがリダイレクトボタンをクリックした後、リダイレクトされます。

自動的にリダイレクトを設定することと手動でのリダイレクトを同時に構成することができます。ユーザーは引き続き、アプリケーションに戻るためのリダイレクトボタンをクリックすることができます。それ以外の場合、構成された遅延時間が経過すると自動的にリダイレクトされます。

注意

制限:

  • API経由で渡されたリダイレクト構成は、パブリッシャーアカウントで構成されたものよりも優先されます。
  • 自動リダイレクト構成は、手動リダイレクト用に設定された構成よりも優先されます。たとえば、手動リダイレクトと遅延時間 0 秒の自動リダイレクトの両方が支払い完了に対して設定されている場合、自動リダイレクトが行われます。

以下のGETパラメータは、ユーザーがリダイレクトされるURLに自動的に追加されます:
  • user_id — ユーザーID。
  • foreigninvoiceexternal_idパラメータで渡されるトランザクションID。
  • invoice_id — トランザクションID。
  • status — トランザクション状況。以下の値を持つことができます:
トランザクション状況。説明
done支払いは正常に完了しました。
invoice支払いのインボイスが生成されました。
delivering支払いはエクソーラ側で処理されています。
troubled支払い処理中または返金処理中にエラーが発生しました。
full_change支払いはエクソーラの残高で行われました。

ユーザーがリダイレクトされるURLの例: {Return URL}?user_id=[value]&foreignInvoice=[value]&invoice_id=[value]&status=done

ユーザーが支払いを完了する前に決済UIタブを閉じた場合、次の形式で指定されたリダイレクトURLにリダイレクトされます:{Return URL}?user_id=[value]&invoice_id=. 決済UIがPay Station Embedで開いた場合、決済UIを閉じるとウィジェットが閉じ、ユーザーはゲームに戻ります。

自動リダイレクトを構成する

以下の場所で自動リダイレクトを構成することができます:

  • パブリッシャーアカウントで
  • API経由で
  • パブリッシャーアカウントでの自動リダイレクトを構成する

    1. パブリッシャーアカウントでプロジェクトを開き、決済ソリューション > 決済インタフェース > 一般設定セクションに移動します。
    2. リダイレクトポリシーセクションに移動します。
    1. リターンURLフィールドに、支払完了後にユーザーがリダイレクトされるURLアドレスまたはパス(ディープリンク)を入力してください。ユーザーがゲームのモバイルアプリケーションで決済UIを開いた際のユーザー体験を向上させるために、リターンURLとしてディープリンクを指定することを推奨します。
    2. ドロップダウンリストから、自動リダイレクト条件を選択します:
      • なし — リダイレクトしない
      • 支払い成功 — 支払いが成功した場合にリダイレクトする。
      • 支払い成功またはキャンセル — 支払いが成功またはキャンセルされた場合にリダイレクトする。
      • 任意の支払い — どの支払いステータスであってもリダイレクトする。
    3. 遅延フィールドに、リダイレクトまでのタイムアウト時間(秒単位)を入力してください。デフォルトでは、リダイレクトは0秒で有効になります。
    4. リダイレクトボタンを追加せず、自動リダイレクトのみを設定したい場合は、手動リダイレクト条件ドロップダウンリストで、なし — リダイレクトしないを選択してください。
    5. 変更内容を保存」をクリックします。

    API経由で自動リダイレクトを構成する

    お知らせ
    異なるプラットフォーム用など、異なるリダイレクトURLを指定したい場合は、それぞれ専用のトークンを作成する必要があります。

    リダイレクトを構成するには、トークンを作成する APIコールで以下のデータを渡します:

    パラメータ説明
    settings.return_urlユーザーが支払いを完了した後にリダイレクトされるURLアドレスまたはパス(ディープリンク)。ユーザーがモバイルアプリケーションで決済UIを開いた際のユーザー体験を向上させるために、リターンURLとしてディープリンクを指定することを推奨します。
    settings.redirect_policy.redirect_conditionsリダイレクト条件:
    • none — リダイレクトしない。
    • successful — 支払いが成功した場合にリダイレクトする。
    • successful_or_canceled — 支払いが成功またはキャンセルされた場合にリダイレクトする。
    • any — すべての支払いステータスでリダイレクトする。
    settings.redirect_policy.delaysettings.return_urlパラメータで指定されたURLへリダイレクトを実行するまでのタイムアウト時間(秒単位)。デフォルトでは、リダイレクトは0秒で有効になります。

    手動リダイレクトを構成する

    以下の場所で手動リダイレクトを構成することができます:

    注意
    API経由で渡されるリダイレクト構成は、パブリッシャーアカウントで設定されたものよりも優先されます。

    パブリッシャーアカウントでの手動リダイレクトを構成する

    1. パブリッシャーアカウントでプロジェクトを開き、決済ソリューション > 決済インタフェース > 一般設定セクションに移動します。
    2. リダイレクトポリシーセクションに移動します。
    1. リターンURLフィールドに、支払完了後にユーザーがリダイレクトされるURLアドレスまたはパス(ディープリンク)を入力してください。ユーザーがゲームのモバイルアプリケーションで決済UIを開いた際のユーザー体験を向上させるために、リターンURLとしてディープリンクを指定することを推奨します。
    2. 手動リダイレクトのみを設定したい場合は、自動リダイレクト条件ドロップダウンリストでなし — リダイレクトしないを選択してください。
    3. 遅延フィールドは空欄のままにしてください。
    4. 手動リダイレクト条件ドロップダウンリストで、リダイレクトボタンが表示される支払いステータスを選択します:
      • なし — リダイレクトしない
      • 支払い成功 — 支払いが成功した場合にリダイレクトする。
      • 支払い成功またはキャンセル — 支払いが成功またはキャンセルされた場合にリダイレクトする。
      • 任意の支払い — どの支払いステータスであってもリダイレクトする。
    5. リダイレクトボタンのキャプションフィールドに、ユーザーをリターンURLへリダイレクトするボタンに表示するテキストを入力します。
    6. 変更内容を保存」をクリックします。
    注意

    デフォルトでは、リダイレクトボタンのコピーはゲームに戻るとなっています。これは、すべてのペイステーション言語にローカライズされています。

    プロジェクトが複数の言語をサポートしている場合は、それぞれのフィールドにリダイレクトボタンのコピーを入力できます。

    ユーザーが決済UIを閉じると、指定したリターンURLにもリダイレクトされます。

    API経由で手動リダイレクトを構成する

    お知らせ
    異なるプラットフォーム用など、異なるリダイレクトURLを指定したい場合は、それぞれ専用のトークンを作成する必要があります。

    リダイレクトを構成するには、トークンを作成する APIコールで以下のデータを渡します:

    パラメータ説明
    settings.return_urlユーザーが支払いを完了した後にリダイレクトされるURLアドレスまたはパス(ディープリンク)。ユーザーがモバイルアプリケーションで決済UIを開いた際のユーザー体験を向上させるために、リターンURLとしてディープリンクを指定することを推奨します。
    settings.redirect_policy.manual_redirection_actionユーザーが「閉じる」ボタンまたは「戻る」ボタンをクリックしたときにトリガーされる決済UIの動作:
    • redirect (デフォルト) — ユーザーはリターンURLにリダイレクトされます。
    • postmessage — 「閉じる」アイコンをクリックするとcloseイベントの送信が開始され、「戻る」ボタンをクリックするとreturnイベントの送信が開始されます。この場合、ユーザーはリターンURLにリダイレクトされません。決済UIの終了またはリダイレクトのために、イベントの処理を設定する必要があります。この設定は、APIを使用している場合にのみ利用可能です。
    settings.redirect_policy.redirect_button_captionユーザーをリターンURLへリダイレクトするボタンに表示するテキスト。
    settings.redirect_policy.status_for_manual_redirectionリダイレクトボタンが表示される支払いステータス:
    • none — リダイレクトしない。
    • successful — 支払いが成功した場合にリダイレクトする。
    • successful_or_canceled — 支払いが成功またはキャンセルされた場合にリダイレクトする。
    • any — すべての支払いステータスでリダイレクトする。
    注意
    決済UIがiframeで開かれており、settings.ui.desktop.header.close_buttonパラメータがtrueに設定されている場合、ユーザーが閉じるアイコンをクリックするとpostmessageイベントのみが送信されます。これにより、イベントを処理して決済UIを閉じることができ、ユーザーは決済が開始されたページにとどまることができます。

    リダイレクト構成の例

    パブリッシャーアカウントで、3秒間の遅延を伴う自動リダイレクトを設定しました。この操作は、モバイル版とデスクトップ版の両方の決済UIに適用されます。パブリッシャーアカウントで設定されたコンフィギュレーションは次のようになります:

    ゲームのモバイルアプリケーションで決済UIを開くための設定を更新する必要がある場合、つまり、リダイレクトボタンを追加したり、リターンURLとしてディープリンクを指定したりするには、トークンで渡された設定を更新する必要があります:

    パラメータ
    settings.return_urlユーザーをゲームアプリケーションにリダイレクトするディープリンク。
    settings.redirect_policy.redirect_conditionsany
    settings.redirect_policy.manual_redirection_actionredirect
    settings.redirect_policy.redirect_button_captionリダイレクトボタンのコピー。
    トークン取得のリクエストは次のようになります:
    Copy
    Full screen
    Small screen
     1{
     2    "user": {
     3        "country": {
     4            "value": "US"
     5        },
     6        "id": {
     7            "value": "1234abCd"
     8        },
     9        "name": {
    10            "value": "John Smith"
    11        }
    12    },
    13    "settings": {
    14        "currency": "USD",
    15        "project_id": 123456,
    16        "language": "en",
    17        "return_url": "myapp://payment/successful",
    18        "ui": {
    19            "desktop": {
    20                "header": {
    21                    "visible_logo": true
    22                }
    23            }
    24        },
    25        "redirect_policy": {
    26            "redirect_conditions": "any",
    27            "redirect_button_caption": "Back to Store",
    28            "manual_redirection_action": "redirect",
    29            "status_for_manual_redirection": "any"
    30        },
    31        "external_id": "1a2b3c"
    32    },
    33    "custom_parameters": {
    34        "timestamp": 1234512345123,
    35        "sku": "testSKU",
    36        "amount": "10"
    37    },
    38    "purchase": {
    39        "virtual_items": {
    40            "items": [
    41                {
    42                    "sku": "testSKU",
    43                    "amount": 1
    44                }
    45            ]
    46        }
    47    }
    48}
    
    この記事は役に立ちましたか?
    ありがとうございます!
    改善できることはありますか? メッセージ
    申し訳ありません
    この記事が参考にならなかった理由を説明してください。 メッセージ
    ご意見ありがとうございました!
    あなたのメッセージを確認し、体験を向上させるために利用させていただきます。
    最終更新日: 2025年11月13日

    誤字脱字などのテキストエラーを見つけましたか? テキストを選択し、Ctrl+Enterを押します。

    問題を報告する
    当社は常にコンテンツを見直しています。お客様のご意見は改善に役立ちます。
    フォローアップ用のメールをご提供してください
    ご意見ありがとうございました!
    フィードバックを送信できませんでした
    後でもう一度お試しいただくか、doc_feedback@xsolla.comまでお問い合わせください。