Xsolla-logo

Token erstellen

post/merchants/{merchant_id}/token

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 Subscriptions-Produkt integriert haben.

Hinweis

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

Händler-ID.

Request Body schema: application/json
object

Dieses Objekt enthält Parameter für die Konfiguration von Betrugsschutzfiltern. Die Liste der Parameter ist unten aufgeführt. Wenn Sie benutzerdefinierte Parameter hinzufügen möchten, wenden Sie sich an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com.

active_date
string

Letztmalig online; Datum gemäß ISO 8601.

additional_verification
boolean

Filtert danach, ob der Spieler Konto-Verifikationsverfahren verwendet.

character_customized
boolean

Filtert danach, ob der Spieler seinen Charakter individuell angepasst hat.

chat_activity
boolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

completed_tasks
integer

Anzahl der erledigten Aufgaben bzw. erreichten Ziele.

forum_activity
boolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

items_used
boolean

Filtert danach, ob der Spieler im Spiel gekaufte Gegenstände verwendet.

karma_points
integer

Karma des Spielers.

last_change_password_date
string

Datum der letzten Kennwortänderung; Datumsangabe gemäß ISO 8601.

non_premium_currency
number <float>

Betrag der gewöhnlichen ("non-premium") Währung.

notifications_enabled
boolean

Filtert danach, ob der Spieler den Erhalt von Benachrichtigungen aktiviert hat.

profile_completed
boolean

Filtert danach, ob der Spieler auf seinem Profil zusätzliche Informationen hinzugefügt hat.

profile_image_added
boolean

Filtert danach, ob der Spieler ein Profilbild hochgeladen hat.

pvp_activity
boolean

Filtert danach, ob der Spieler an PvP-Schlachten teilnimmt.

registration_date
string

Datum der Kontoerstellung gemäß ISO 8601.

session_time
string

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
number <float>

Gesamtwert des Inventars (in Ingame-Währung).

total_sum
number <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 Subscriptions > Abo-Modelle.

product_id
string

Produkt-ID.

trial_days
integer

Probezeitraum in Tagen.

object

Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Benutzer.

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. Muss für jede Benutzerzahlung eindeutig sein. Detaillierte Informationen dazu finden Sie in der Dokumentation.

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).

delay
integer

Verzögerung (in Sekunden), nach der ein Benutzer automatisch zur Rückgabe-URL weitergeleitet wird.

manual_redirection_action
string

Das Verhalten der Pay Station 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.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

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.

Enum: "none" "successful" "successful_or_canceled" "any"
return_url
string

URL der Seite, zu der ein Benutzer nach dem Bezahlen weitergeleitet wird. Wie Sie Weiterleitungen konfigurieren, erfahren Sie in der Dokumentation.

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).

currency_format
string

Damit ein Währungscode bestehend aus drei Buchstaben gemäß ISO 4217 im Zahlungsportal angezeigt wird, müssen Sie code als Wert festlegen. Standardmäßig wird das Währungssymbol anstelle des Währungscodes angezeigt.

object

Schnittstellen-Einstellungen für die Desktop-Version (Objekt).

object

Einstellungen für den Header (Objekt).

close_button
boolean

Ob eine Schließen-Schaltfläche im Zahlungsportal angezeigt wird. Die Schaltfläche schließt das Zahlungsportal 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

Wenn true festgelegt ist, wird im Header Ihr Logo angezeigt (dafür müssen Sie das Bild zuerst Ihrem Customer Success Manager übermitteln).

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.

object
visible_virtual_currency_balance
boolean

Legt fest, ob dieses Element im Zahlungsportal ausgeblendet werden kann. true voreingestellt.

is_cart_open_by_default
boolean

Wie die Artikelliste im Warenkorb beim Öffnen der mobilen Zahlungsportal-Version angezeigt wird. Wenn true festgelegt ist, wird die Liste ausgeklappt angezeigt. Wenn false (Standard) festgelegt ist oder der Parameter nicht übermittelt wird, wird die Liste zusammengeklappt angezeigt.

is_independent_windows
boolean

Ob die Benutzer beim Kauf vom im Startprogramm eingebetteten Browser (WebView) zu ihrem Standardbrowser weitergeleitet werden sollen. false ist voreingestellt.

is_payment_methods_list_mode
boolean

Ob die Liste der im Land des Benutzers verfügbaren Zahlungsmethoden beim Öffnen des Zahlungsportals angezeigt wird. Ist false festgelegt (Standard), wird die im Parameter settings.payment_method übermittelte Zahlungsmethode oder die vom PayRank-Algorithmus ausgewählte Zahlungsmethode angezeigt.

is_prevent_external_link_open
boolean

Ob die Umleitung von Links auf eine externe Ressource deaktiviert ist oder nicht. false 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.

is_show_close_widget_warning
boolean

Legt fest, ob eine Warnung über die Verarbeitung der Transaktion angezeigt werden soll, wenn der Mauszeiger über das Symbol × bewegt wird, bevor die Zahlungsseite geschlossen wird. Wenn false übermittelt wird, oder der Parameter nicht übermittelt wird, wird die Warnung nicht angezeigt. Es ist standardmäßig auf true gestellt.

is_three_ds_independent_windows
boolean

Ob die "3-D Secure"-Prüfung in einem neuen Browserfenster geöffnet werden soll. false ist voreingestellt. Übermitteln Sie true, wenn Sie die Content Security Policy (CSP) nutzen.

layout
string

Position der Hauptelemente des Zahlungsportals. Sie können das Zahlungsportal im Spiel öffnen und/oder die Spalte mit den Bestellinformationen und den Angaben zu den Zahlungsmethoden vertauschen. Ausführliche Informationen finden Sie in den Anpassungsanweisungen.

Enum: "embed" "column_reverse" "embed_column_reverse"
object
object
close_button
boolean

Legt fest, ob eine Schließen-Schaltfläche in der Mobil-Version der Pay Station angezeigt wird. Die Schaltfläche schließt die Pay Station und leitet den Benutzer an die im settings.return_url-Parameter angegebene URL weiter. Standardmäßig ist false voreingestellt.

mode
string

Schnittstellenmodus in der Pay Station. 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.

theme
string

Zahlungsportal-Theme. Möglich sind "63295a9a2e47fab76f7708e1" (helles Theme – voreingestellt) oder "63295aab2e47fab76f7708e3" (dunkles Theme). Sie können außerdem ein individuelles Theme erstellen und dessen ID im Parameter übermitteln.

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"
object

Details zum Benutzerkonto (Objekt).

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 Gespeicherte Methoden.

enable
boolean

Legt fest, ob das Stiftsymbol, das zur Bearbeitungsseite für Zahlungsmethoden weiterleitet, im Zahlungsportal angezeigt werden soll. Standardmäßig ist true festgelegt.

object

Abschnitt Abonnements verwalten.

enable
boolean

Ob der Abschnitt angezeigt wird. Standardwert ist false.

order
integer

Position des Abschnitts in der Drop-down-Liste.

object

Benutzerdaten (Objekt).

required
object
value
required
string

Unique user ID in the game stored on your side. Make sure you pass the existing user ID. In case an error occurs, refer to the answers to the FAQs.

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.

value
string

Ländercode, bestehend aus zwei Großbuchstaben gemäß ISO 3166-1 ALPHA-2.

object <= 100 characters

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_legal true 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 = 32 characters

Eindeutige Benutzer-ID – wird in Marketingkampagnen verwendet. Kann Ziffern und lateinische Zeichen enthalten.

object

Datenverkehrsattribute (Objekt).

utm_campaign
string

Kampagnenbezeichnung, ins Englische transliteriert oder übersetzt.

utm_content
string

Kampagneninhalt.

utm_medium
string

Datenverkehrskanal (kontextbezogene Anzeigen, mediale Anzeigen, E-Mail-Listen, usw.).

utm_source
string

Ursprung des Datenverkehrs.

utm_term
string

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.

Responses
200

Created.

422

Unprocessable Entity.

Request samples
application/json
{
  • "settings": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}