Xsolla-logo

Token erstellenServer-side

post/merchants/{merchant_id}/token

Sie können einen Token mit beliebigen Benutzerparametern erstellen. Diese Parameter senden Sie beim Erhalt des Tokens und erhalten sie nach einer erfolgreichen Zahlung zurück. Ein Token kann nur Parameter enthalten, die entweder in diesem Dokument beschrieben oder von Ihnen vordefiniert sind.

Wenn ein Parameter im falschen Format gesendet wird oder den falschen Typ hat, wird kein Token ausgestellt. Sie erhalten einen 422-HTTP-Code mit der Fehlerbeschreibung im JSON-Body. In extended_message erhalten Sie eine Information, welche genauen Parameter falsch gesendet wurden.

Bemerkung

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

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 übermitteln, um Betrugsschutzfilter zu konfigurieren. Die empfohlenen Parameter werden in der Drop-down-Liste angezeigt. Siehe Pay-Station-Dokumentation .

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
integer <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
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

Objekt, welches Angaben zur Bezahlung enthält.

amount
integer <float>

Kaufbetrag.

currency
string

Kaufwährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

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.

object

Details des Geschenkabonnements.

recipient
required
string

ID des Empfängers.

email
required
string

E-Mail-Adresse des Empfängers.

anonymous
boolean

Ob der Name des Geschenkgebers verborgen werden soll. Wenn true, ist der Name des Geschenkgebers in der E-Mail-Benachrichtigung nicht sichtbar. Standardwert ist false.

message
string

Nachricht für den Empfänger.

redirect_url
string

Geben Sie hier einen Link zu einer Seite mit zusätzlichen Informationen über das Geschenkabonnement oder zur Seite für die Kontoerstellung an. Der Geschenkempfänger kann von der E-Mail-Benachrichtigung aus zu dieser Seite navigieren.

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

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

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

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.

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

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

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

Untermenü Historie.

enable
boolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

order
integer

Position des Untermenüs im Hauptmenü.

object

Seite Mein Konto.

enable
boolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

order
integer

Position des Untermenüs im Hauptmenü.

object

Untermenü Meine Zahlungsarten.

enable
boolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

order
integer

Position des Untermenüs im Hauptmenü.

object

Untermenü Abonnements verwalten.

enable
boolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

order
integer

Position des Untermenüs im Hauptmenü.

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.

value
string

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

object

Das user.email Objekt ist ein integraler Bestandteil beim Aufbau von Anti-Betrugsmodellen und hilft, die Akzeptanzraten zu erhöhen. Es ist sowohl für Xsolla als auch für Zahlungssysteme erforderlich. Wenn der Parameter nicht übergeben wird, erscheint auf der Bezahlseite das Pflichtfeld zur Eingabe der E-Mail. Ein Benutzer erhält eine Kaufbestätigung an die im Parameter übergebene oder auf der Bezahlseite eingegebene E-Mail.

value
required
string

E-Mail-Adresse des Benutzers. Muss gemäß RFC 822-Protokoll gültig sein.

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

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
{
  • "purchase": {
    },
  • "settings": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}