Sie können einen Token mit beliebigen Nutzerparametern erstellen. Sie senden
diese Parameter beim Abruf des Tokens, nach einer erfolgreichen Zahlung
erhalten Sie die Parameter zurück. Ein Token kann nur Parameter enthalten, die
entweder in diesem Dokument beschrieben sind oder von Ihnen vorab definiert
wurden.
Falls irgendein Parameter in einem unzulässigen Format oder als falscher Typ
gesendet wird, wird kein Token ausgegeben. Als Antwort erhalten Sie den HTTP-
Statuscode 422 samt Fehlerbeschreibung im JSON-Body. Der Parameter
extended_message gibt Aufschluss darüber, welche Parameter falsch waren.
Hinweis
Der Token, den Sie nach dem Aufruf dieser API-Methode erhalten, kann nur zur Autorisierung anderer Anfragen verwendet werden. Sie können diesen Token zum Öffnen des Zahlungsportals nur dann verwenden, wenn Sie das Abonnements-Produkt integriert haben.
SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer
Händler-ID.
Request Body schema: application/json
object
Sie können zusätzliche Parameter im Token im custom_parameters Objekt übergeben, um Betrugsschutzfilter zu konfigurieren. Die empfohlenen Parameter werden in der Dropdown-Liste angezeigt. Siehe Bezahlstation-Dokumentation.
Durchschnittliche Sitzungsdauer, Angabe gemäß ISO 8601.
social_networks_added
boolean
Filtert danach, ob der Spieler Profile von sozialen Netzwerken verknüpft hat.
total_bans
integer
Filtert danach, wie oft der Spieler im Chat/Forum gesperrt wurde.
total_characters
integer
Anzahl der Charaktere im Spiel.
total_clans
integer
Anzahl der Clans, bei denen der Spieler Mitglied ist.
total_friends
integer
Anzahl der Freunde.
total_game_events
integer
Anzahl der Ingame-Events, an denen der Spieler teilgenommen hat.
total_gifts
integer
Anzahl der Geschenke im Spiel, die der Spieler verschickt/erhalten hat.
total_hours
integer
Gesamtzahl der Spielstunden.
total_inventory_value
integer <float>
Gesamtwert des Inventars (in Ingame-Währung).
total_sum
integer <float>
Gesamtbetrag der Zahlungen.
tutorial_completed
boolean
Filtert danach, ob der Spieler das Tutorial des Spiels absolviert hat.
unlocked_achievements
integer
Anzahl an freigeschalteten Errungenschaften.
user_level
integer
Level, Ansehen oder Rang des Spielers.
win_rate
integer
Gewinnquote.
object
Objekt, welches Angaben zum Kauf enthält.
object
Daten zum Abonnement (Objekt).
available_plans
Array of strings
Abonnement-Modelle (Array), die im Zahlungsportal angezeigt werden sollen.
currency
string
Währung des Abo-Modells, die bei allen Kalkulationen verwendet werden soll.
operation
string
Diese Operationsart kommt beim Abo-Modell des Nutzers zur Anwendung. Zur Änderung des Abo-Modells muss der change_plan-Wert übermittelt werden. Sie müssen die ID des neuen Abo-Modells im purchase.subscription.plan_id-Parameter festlegen.
plan_id
string
Externe ID des Abo-Modells. Diese finden Sie im Kundenportal unter Abonnements > Abo-Modelle.
product_id
string
Produkt-ID.
trial_days
integer
Probezeitraum in Tagen.
object
Benutzerdefinierte Projekteinstellungen (Objekt).
project_id
required
integer
Xsolla-ID des Spiels. Kann im Kundenportal eingesehen werden.
currency
string
Bevorzugte Zahlungswährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.
external_id
string
Transaktions-ID im Spiel. Eine individuelle ID pro Benutzerzahlung erforderlich.
language
string
Sprache der Benutzeroberfläche. Sprachencode, bestehend aus 2 Kleinbuchstaben.
mode
string
Legen Sie als Wert sandbox fest, um den Zahlungsvorgang auszutesten. Für einen solchen Fall nutzen Sie https://sandbox-secure.xsolla.com, um das Zahlungsportal auszutesten.
payment_method
integer
ID der Zahlungsart.
payment_widget
string
Zahlungs-Widget. Kann paybycash oder giftcard sein. Wenn der Parameter festgelegt ist, wird der Benutzer entsprechend zum Widget "Pay by Cash" oder zum Widget "Gift Cards" weitergeleitet.
Enum:"paybycash""giftcard"
object
Weiterleitungsrichtlinien-Einstellungen (Objekt).
autoredirect_from_status_page
boolean
Legt fest, ob die Weiterleitung von der Statusseite automatisch erfolgt.
delay
integer
Verzögerung (in Sekunden), nach der ein Benutzer automatisch zur Rückgabe-URL weitergeleitet wird.
manual_redirection_action
string
Das Verhalten der Bezahlstation wird ausgelöst, wenn der Benutzer auf die Schaltfläche Schließen oder die Schaltfläche Zurück zum Spiel klickt. Kann redirect (standardmäßig) und postmessage sein. Wenn auf redirect gesetzt, wird ein Benutzer zu der im Token übergebenen oder im Kundenportal angegebenen URL umgeleitet. Wenn er auf postmessage gesetzt ist, wird ein Benutzer nicht auf andere Seiten umgeleitet. Durch Klicken auf das Schließen-Symbol wird das close Ereignis gesendet, und durch Klicken auf die Schaltfläche Zurück zum Spiel - das return Ereignis.
Enum:"redirect""postmessage"
redirect_button_caption
string
Text auf der Schaltfläche für die manuelle Weiterleitung.
redirect_conditions
string
Zahlungsstatus, bei dem ein Benutzer zur Rückgabe-URL weitergeleitet wird. Möglich sind: none, successful, successful_or_canсeled oder any.
Zahlungsstatus, bei dem eine Schaltfläche angezeigt wird, die einen Benutzer zur Rückgabe-URL weiterleitet. Möglich sind: none, successful, successful_or_canсeled oder any.
Seite, zu welcher der Benutzer nach der Zahlung weitergeleitet wird. Die folgenden Parameter werden dem Link automatisch hinzugefügt: user_id, foreigninvoice, invoice_id, status.
object
Schnittstellen-Einstellungen (Objekt).
object
Menü-Einstellungen (Objekt).
object
Untermenü "Abo-Modelle" (Objekt).
hidden
boolean
Legt fest, ob das Untermenü angezeigt wird.
order
integer
Position des Untermenüs im Hauptmenü.
object
Untermenü "Virtuelle Währung".
custom_amount
boolean
Legt fest, ob der Benutzer eine willkürliche Menge der virtuellen Währung im Zahlungsportal eingeben kann.
hidden
boolean
Legt fest, ob das Untermenü angezeigt wird.
order
integer
Position des Untermenüs im Hauptmenü.
object
Untermenü "Virtuelle Gegenstände".
hidden
boolean
Legt fest, ob das Untermenü angezeigt wird.
order
integer
Position des Untermenüs im Hauptmenü.
selected_group
string
Gruppe, die nach dem Öffnen der Registerkarte "Virtuelle Gegenstände" angezeigt wird.
selected_item
string
Gegenstand, der nach dem Öffnen der Registerkarte "Virtuelle Gegenstände" angezeigt wird (SKU des Gegenstands).
object
Schnittstellen-Einstellungen für die Desktop-Version (Objekt).
object
Einstellungen für den Header (Objekt).
close_button
boolean
Legt fest, ob eine Schließen-Schaltfläche in der Desktop-Version der Bezahlstation angezeigt wird. Die Schaltfläche schließt die Bezahlstation und leitet den Benutzer an die im settings.return_url-Parameter angegebene URL weiter. Standardmäßig ist false voreingestellt.
is_visible
boolean
Legt fest, ob der Header im Zahlungsportal angezeigt wird.
type
string
Erscheinungsbild des Headers. Als Wert lässt sich entweder compact (Projektname und Benutzer-ID sind ausgeblendet) oder normal (voreingestellt) festlegen.
Enum:"compact""normal"
visible_logo
boolean
Falls der Wert true festgelegt ist, erscheint Ihr Logo im Header (senden Sie dazu das Logo als Bilddatei an Ihren Account Manager).
visible_name
boolean
Legt fest, ob der Projektname im Header angezeigt wird.
visible_purchase
boolean
Legt fest, ob die Kaufbeschreibung (purchase.description.value) im Header angezeigt wird. true ist voreingestellt.
object
Einstellungen zur Liste der Abo-Modelle (Objekt).
description
string
Jeglicher Text, der im Zahlungsportal oberhalb der Liste der verfügbaren Abo-Modelle angezeigt werden soll.
display_local_price
boolean
Falls als Wert true festgelegt ist und falls die Landeswährung des Benutzers sich von der für das Abo-Modell festgelegten Währung unterscheidet, werden dem Benutzer beide Preise angezeigt: Einer in der Landes- und der andere in der Basiswährung.
layout
string
Listenvorlage. Als Wert lässt sich entweder list (voreingestellt) oder grid festlegen.
Enum:"list""grid"
object
Einstellungen zur Liste der virtuellen Währungen (Objekt).
button_with_price
boolean
Falls als Wert true festgelegt ist, wird der Preis auf der Schaltfläche angezeigt. Falls false festgelegt ist, wird der Preis links neben der Schaltfläche angezeigt. Standardwert ist false.
description
string
Jeglicher Text, zur Anzeige oberhalb der Liste der virtuellen Währungen.
object
Einstellungen zur Liste der virtuellen Gegenstände (Objekt).
button_with_price
boolean
Falls als Wert true festgelegt ist, wird der Preis auf der Schaltfläche angezeigt. Falls false festgelegt ist, wird der Preis links neben der Schaltfläche angezeigt. Standardwert ist false.
layout
string
Listenvorlage. Als Wert lässt sich entweder list (voreingestellt) oder grid festlegen.
Enum:"list""grid"
view
string
Virtuelle Gruppe an Elementen in vertikalem/horizontalem Menü anzeigen. Es kann horizontal_navigation oder vertical_navigation (Standard) sein.
Enum:"horizontal_navigation""vertical_navigation"
object
visible_virtual_currency_balance
boolean
Legt fest, ob dieses Element im Zahlungsportal ausgeblendet werden kann. true voreingestellt.
is_prevent_external_link_open
boolean
Ob die Umleitung von Links auf eine externe Ressource deaktiviert ist oder nicht. true standardmäßig. Wenn Sie auf einen externen Link klicken, wird das external-link-open Ereignis über den postMessage Mechanismus gesendet. Die Adresse für den umgeleiteten Link wird im url Parameter übergeben.
license_url
string
Link zur EULA.
object
object
is_visible
boolean
Legt fest, ob der Footer in der mobilen Version des Zahlungsportals ausgeblendet ist.
object
close_button
boolean
Legt fest, ob eine Schließen-Schaltfläche in der Mobil-Version der Bezahlstation angezeigt wird. Die Schaltfläche schließt die Bezahlstation und leitet den Benutzer an die im settings.return_url-Parameter angegebene URL weiter. Standardmäßig ist false voreingestellt.
mode
string
Ein Benutzer kann nur mit seinen gespeicherten Zahlungsarten bezahlen. Als Wert lässt sich lediglich saved_accounts festlegen.
Value:"saved_accounts"
mode
string
Schnittstellenmodus in der Bezahlstation. Als Wert lässt sich lediglich user_account festlegen: Der Header enthält ausschließlich die Navigationsleiste des Benutzerkontos und der Benutzer kann kein Produkt auswählen oder eine Zahlung tätigen. Dieser Modus ist nur in der Desktop-Version verfügbar.
size
string
Größe des Zahlungsportals. Folgende Größen sind möglich:
small: die kleinstmögliche Größe des Zahlungsportals. Verwenden Sie diese, wenn die Fenstergröße begrenzt ist (Abmessungen: 620 x 630)
medium: empfohlene Größe. Verwenden Sie diese, um das Zahlungsportal in einer Lightbox darzustellen (Abmessungen: 820 x 840)
large: optimal für die Anzeige des Zahlungsportals in einem neuen Fenster/Registerkarte (Abmessungen: 820 x 840)
Enum:"small""medium""large"
theme
string
Theme des Zahlungsportals. Als Wert lässt sich entweder default (voreingestellt) oder default_dark festlegen.
Enum:"default""default_dark"
object
Details zum Benutzerkonto (Objekt).
object
Abschnitt Historie.
enable
boolean
Ob der Abschnitt angezeigt wird. Standardwert ist false.
order
integer
Position des Abschnitts in der Drop-down-Liste.
object
Seite Mein Konto.
enable
boolean
Ob der Abschnitt angezeigt wird. Standardwert ist false.
order
integer
Position des Abschnitts in der Drop-down-Liste.
object
Abschnitt Meine Zahlungskonten.
enable
boolean
Legt fest, ob der Abschnitt in der in der Drop-down-Liste im Zahlungsportal angezeigt wird. Standardwert ist true. Wenn Sie diesen Parameter nicht übermitteln, wird der Abschnitt angezeigt.
order
integer
Position des Abschnitts in der Drop-down-Liste im Zahlungsportal.
object
Abschnitt Abonnements verwalten.
enable
boolean
Ob der Abschnitt angezeigt wird. Standardwert ist false.
order
integer
Position des Abschnitts in der Drop-down-Liste.
version
string
Gerätetyp. Als Wert lässt sich entweder desktop (voreingestellt) oder mobile festlegen.
Enum:"desktop""mobile"
object
Benutzerdaten (Objekt).
required
object
value
required
string
Benutzer-ID.
age
integer
Alter des Benutzers.
attributes
object
Benutzerattribute zum Filtern der Liste der Gegenstände; repräsentiert durch eine gültige Reihe von JSON-Objekten bestehend aus Schlüssel-Wert-Paaren.
object
allow_modify
boolean
Legt fest, ob ein Benutzer das Land im Zahlungsportal ändern darf. Wenn country.value im Token übermittelt wird, ist der Wert standardmäßig auf false gestellt.
Das user.email Objekt ist ein integraler Bestandteil beim Aufbau von Betrugsbekämpfungsmodellen und trägt zur Erhöhung der Akzeptanzraten bei. Es ist sowohl für Xsolla als auch für Zahlungssysteme erforderlich. Falls der Parameter nicht übergeben wird, erscheint auf der Zahlungsseite das Pflichtfeld zur Eingabe der E-Mail. Ein Benutzer erhält einen Kaufbeleg an die im Parameter übergebene oder auf der Zahlungsseite eingegebene E-Mail.
value
required
string
E-Mail-Adresse des Benutzers. Muss gemäß RFC 822-Protokoll gültig sein.
allow_modify
boolean
Legt fest, ob ein Benutzer seine E-Mail in der Zahlungsoberfläche eingeben kann. Falls der user.email.value Parameter im Token übergeben wird, ist der Wert standardmäßig false.
is_legal
boolean
Legt fest, ob der Benutzer eine juristische Person ist.
object
Objekt mit Angaben zur juristischen Person. Objekt und alle seine Parameter sind erforderlich, falls für user.is_legaltrue festgelegt ist.
address
string
Vollständige Unternehmensanschrift.
country
string
Land des Unternehmenssitzes. Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.
name
string
Vollständiger Name des Unternehmens.
vat_id
string
Steuerliche Identifikationsnummer.
object
allow_modify
boolean
Legt fest, ob ein Benutzer seine E-Mail in der Zahlungsoberfläche eingeben kann. Falls der user.name.value Parameter im Token übergeben wird, ist der Wert standardmäßig false.
value
string
Benutzername.
object
value
string
Telefonnummer des Benutzers.
object
value
string
Parameter, durch den der Benutzer eindeutig identifizierbar ist und der dem Benutzer bekannt ist (E-Mail, Benutzername, usw.). Gestattet dem Benutzer, Käufe außerhalb des Game-Stores zu tätigen (z. B. via Verkaufsterminals).
object
value
string
Steam-ID.
object
value
string
Eindeutige Tracking-ID (wird bei Marketingkampagnen verwendet).
object
Datenverkehrsattribute (Objekt).
utm_campaign
string
Kampagnenbezeichnung, ins Englische transliteriert oder übersetzt.
Kampagnen-Keyword. Falls festgelegt, basieren die Statistiken auf den Keywords, die für die Zielgruppenwerbung verwendet werden, anstatt auf spezifischen Suchanfragen. In Google Analytics ist der angegebene utm_term Teil des allgemeinen Berichts zu Suchbegriffen.
