Öffnen des Zahlungsportals konfigurieren

Je nach den Einstellungen für die Projektauthentifizierung können Sie eine der folgenden Möglichkeiten verwenden, um das Zahlungsportal zu öffnen:

• serverseitiger API-Aufruf "Token erstellen", sofern:
  • Sie Ihr eigenes Autorisierungssystem in Ihrer Anwendung verwenden.
  • in Ihrem Projekt Abo-Modelle mit einer Abonnementgebühr gemäß der ersten Zahlung vorhanden sind.
• clientseitiige Methode für den Abruf eines Links zum Öffnen des Zahlungsportals, sofern Sie Xsolla-Login in Ihrem Projekt verwenden.

Über den serverseitigen API-Aufruf "Token erstellen"

1. Implementieren Sie den Abruf eines Tokens, damit beim Öffnen des Zahlungsportals eine der folgenden Seiten angezeigt wird:
   • Seite zur Auswahl der Zahlungsmethode
   • Seite zur Eingabe der Zahlungsdaten
2. Implementieren Sie, worin das Zahlungsportal geöffnet werden soll:
   • Pay Station Embed-Skript
   • Iframe
   • Neues Fenster

Anzeige der Seite für die Auswahl der Zahlungsmethode

Damit das Zahlungsportal beim Öffnen die Seite zur Auswahl der Zahlungsmethode anzeigt, übermitteln Sie den Parameter purchase.subscription.plan_id samt der ID des ausgewählten Abo-Modells an den API-Aufruf Token erstellen. Übermitteln Sie bei Bedarf die zusätzlichen Parameter für die Anpassung.

curl -v https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token \
-X POST \
-u your_merchant_id:merchant_api_key \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-d '
{
  "user":{
    "id":{
      "value": "1234567",
      "hidden": true
    },
    "email": {
      "value": "user1234@game1234.com"
    },
    "name": {
      "value": "UserName",
      "hidden": false
    }
  },
  "settings": {
    "project_id": 12345,
    "currency": "USD"
  },
  "purchase": {
    "subscription": {
      "plan_id": "54321"
    }
  }
}'

Seite zur Auswahl der Zahlungsmethode (Beispiel):

Anzeige der Seite zur Eingabe der Zahlungsdaten

Damit das Zahlungsportal beim Öffnen die Seite zur Eingabe der Zahlungsdaten anzeigt, übermitteln Sie die folgenden Parameter an den API-Aufruf Token erstellen:

• purchase.subscription.plan_id samt ID des ausgewählten Abo-Modells.
• settings.payment_method samt der ID der Zahlungsmethode. Die Liste der IDs finden Sie in Ihrem Projekt im Kundenportal unter Pay Station > Zahlungsarten, oder bitten Sie den Customer Success Manager um Zusendung.

Übermitteln Sie bei Bedarf zusätzliche Parameter für die Anpassung.

curl -v https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token \
-X POST \
-u your_merchant_id:merchant_api_key \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-d '
{
  "user":{
    "id":{
      "value": "1234567",
      "hidden": true
    },
    "email": {
      "value": "user1234@game1234.com"
    },
    "name": {
      "value": "UserName",
      "hidden": false
    }
  },
  "settings": {
    "project_id": 12345,
    "payment_method": 1380,
    "currency": "USD"
  },
  "purchase": {
    "subscription": {
      "plan_id": "54321"
    }
  }
}'

Eingabeseite für Zahlungsdaten (Beispiel):

Über clientseitige API-Methode

1. Implementieren Sie mithilfe der clientseitigen API-Methode den Abruf eines Links zum Öffnen des Zahlungsportals.
2. Implementieren Sie, worin das Zahlungsportal geöffnet werden soll. Möglich sind:
   • Pay Station Embed-Skript
   • Iframe
   • Neues Fenster

Clientseitige API-Methode für den Abruf eines Links zum Öffnen des Zahlungsportals

Nutzen Sie aufseiten Ihres Anwendungs-Clients eine HTTP-POST-Anfrage, um das Öffnen des Zahlungsportals zu implementieren: https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/buy.

Die Anfrage muss den Header Authorization: Bearer <client_user_jwt> enthalten, wobei <client_user_jwt> der JSON Web Token (JWT) des Benutzer ist – ein eindeutiger, nach dem Base64-Xsolla-Standard kodierter Token. So rufen Sie den Token ab:

• Nutzen Sie die API-Aufrufe Register new user und Auth by username, sofern die Autorisierung bei Ihrer Anwendung über Benutzername und Passwort erfolgt.
• Nutzen Sie den API-Aufruf Auth via social network, sofern die Autorisierung bei Ihrer Anwendung über ein soziales Netzwerk erfolgt.

Geben Sie die Projekt-ID als Pfadparameter projectId an. Sie finden diesen Parameter im Kundenportal neben dem Projektnamen.

Legen Sie country als Abfrageparameter fest – die aus zwei Buchstaben bestehende Bezeichnung des Landes des Nutzers nach der Norm ISO 3166-1 Alpha-2. Beeinflusst die Wahl des Gebietsschemas und der Währung. Wird dieser Parameter nicht übermittelt, wird das Land des Benutzers anhand seiner IP-Adresse ermittelt.

Übermitteln Sie die folgenden Parameter in der Anfrage:

• plan_external_id, damit beim Öffnen des Zahlungsportals die Seite zur Auswahl der Zahlungsmethode angezeigt wird.

Zahlungsportal (Beispiel):

• plan_external_id und settings.payment_method, damit beim Öffnen des Zahlungsportals die Eingabeseite für die Zahlungsdaten angezeigt wird.

Zahlungsportal (Beispiel):

Parameter im Anfragerumpf:

Übermitteln Sie bei Bedarf zusätzliche Parameter für die Anpassung.

curl -X 'POST' \
'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/buy?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

  {
    "plan_external_id": "PlanExternalId",
    "settings": {
      "ui": {
        "size": "large",
        "theme": "string",
        "version": "desktop",
        "desktop": {
          "header": {
            "is_visible": true,
            "visible_logo": true,
            "visible_name": true,
            "type": "compact",
            "close_button": true
          }
        },
        "mobile": {
          "mode": "saved_accounts",
          "footer": {
            "is_visible": true
          },
          "header": {
            "close_button": true
          }
        },
        "mode": "user_account"
        }
      },
      "currency": "string",
      "locale": "string",
      "external_id": "string",
      "payment_method": 1,
      "return_url": "string",
      "redirect_policy": {
        "redirect_conditions": "none",
        "delay": 0,
        "status_for_manual_redirection": "none",
        "redirect_button_caption": "string"
      }
    }

{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}

Mit Pay Station Embed

Fügen Sie Ihrer Webseite ein Skript hinzu, welches das Zahlungsportal-Widget öffnet. Eine vollständige Beschreibung des Skripts finden Sie im GitHub-Repository.

BEISPIEL: ASYNCHRONES LADEN VON SCRIPTEN

<script>
   var options = {
       access_token: 'ACCESS_TOKEN', //TODO use access token, received on previous step
       sandbox: true //TODO please do not forget to remove this setting when going live
   };
   var s = document.createElement('script');
   s.type = "text/javascript";
   s.async = true;
   s.src = "https://static.xsolla.com/embed/paystation/1.0.7/widget.min.js";
   s.addEventListener('load', function (e) {
       XPayStationWidget.init(options);
   }, false);
   var head = document.getElementsByTagName('head')[0];
   head.appendChild(s);
</script>

<button data-xpaystation-widget-open>Buy Credits</button>

Pay Station Embed ermöglicht das Abrufen von Ereignissen aus dem Zahlungsportal via postMessage. Diese Ereignisse können an Analytics-Systeme übermittelt werden. Wenden Sie sich zum Einrichten der Ereignisverarbeitung in Ihrem Analytics-System an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com.

Script-Initialisierungsparameter:

Nutzen Sie den folgenden Link, um das Öffnen des Zahlungsportals zu initialisieren: https://secure.xsolla.com/paystation4/?token=ACCESS_TOKEN, wobei ACCESS_TOKEN der Token ist, den Sie beim Abruf der Methode Token erstellen erhalten haben. Sie können auch einen vorgefertigten Link samt Token erhalten, implementieren Sie dazu die Client-Methode zum Öffnen des Zahlungsportals.

Für Testzwecke steht Ihnen die folgende URL zur Verfügung: https://sandbox-secure.xsolla.com/paystation4/?token=TOKEN.

In einem Iframe

Sie müssen Ihrerseits folgende Mechanismen implementieren:

• Prüfung des Gerätetyps (Desktop oder mobiles Endgerät) und Übermittlung innerhalb des settings.ui.version-Tokenparameters.
• Abrufen von Ereignissen aus dem Zahlungsportal via postMessage. Diese Ereignisse können an Analytics-Systeme gesendet werden. Um die Verarbeitung von Ereignissen in Ihrem Analytics-System einzurichten, wenden Sie sich an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com.

Nutzen Sie zum Öffnen des Zahlungsportals in einem iframe den folgenden Link: https://secure.xsolla.com/paystation4/?token=ACCESS_TOKEN, wobei ACCESS_TOKEN der Token ist, den Sie beim Abruf der Methode Token erstellen erhalten haben. Sie können auch einen vorgefertigten Link samt Token erhalten, implementieren Sie dazu die Client-Methode zum Öffnen des Zahlungsportals.

Zu Testzwecken können Sie diese URL nutzen: https://sandbox-secure.xsolla.com/paystation4/?token=ACCESS_TOKEN.

In einem neuen Fenster

Nutzen Sie zum Öffnen des Zahlungsportals in einem neuen Fenster den folgenden Link: https://secure.xsolla.com/paystation4/?token=ACCESS_TOKEN, wobei ACCESS_TOKEN der Token ist, den Sie beim Abruf der Methode Token erstellen erhalten haben. Sie können auch einen vorgefertigten Link samt Token erhalten, implementieren Sie dazu die clientseitige Methode zum Öffnen des Zahlungsportals.

Zu Testzwecken können Sie diese URL nutzen: https://sandbox-secure.xsolla.com/paystation4/?token=ACCESS_TOKEN.