Filtert danach, ob der Spieler Konto-Verifikationsverfahren verwendet.
Pay Station API (2.0)
- Version: 2.0.0
- Server:
https://api.xsolla.com/api
Pay Station ist eine bequeme Benutzeroberfläche für Ingame-Käufe, dank derer die Partner ihre Produkte monetarisieren können. Wie Sie die Benutzeroberfläche (das "Zahungsportal") öffnen können, erfahren Sie in dieser Anleitung.
Die Pay Station API umfasst die folgenden Gruppen von API-Aufrufen:
- Token – enthält einen API-Aufruf, mit dem sich ein Token samt beliebigen Nutzerparametern für die weitere Zahlungsverarbeitung über das Zahlungsportal generieren lässt.
- Tokenisierung – enthält API-Aufrufe, mit denen sich Zahlungen sicher verarbeiten lassen, ohne das Zahlungsportal zu öffnen oder den Nutzer einzubeziehen.
- Berichte – enthält API-Aufrufe, mit denen sich Daten zu Nutzertransaktionen abrufen, Berichte generieren und Auszahlungen nach Währung aufschlüsseln lassen.
- Erstattung – enthält API-Aufrufe, mit denen sich Geldbeträge komplett oder teilweise erstatten lassen.
- Testen – enthält einen API-Aufruf, mit dem sich der Rückbuchungsprozess testen lässt.
Detaillierte Informationen dazu, wie man das Zahlungsportal konfiguriert, finden Sie im Integrationsleitfaden für die Payments- Lösung.
Hinweis
Auch in der Postman collection im Abschnitt Xsolla Base API finden sich Informationen dazu, wie man die bei der Integration genutzten API-Aufrufe testet.
OpenAPI-Beschreibung herunterladen
Sprachen
Server
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/de/api/pay-station/
Anfrage
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.
Die Lebensdauer eines Tokens beträgt standardmäßig 24 Stunden. Wenn Sie diesen Wert ändern möchten, wenden Sie sich an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com. Der neue Wert wird für alle im Kundenportal erstellten Projekte Ihrer Firma übernommen.
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.
Nutzen Sie den folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: https://secure.xsolla.com/paystation4/?token={token}, wobei {token} der erhaltene Token ist.
Für Testzwecke steht Ihnen die folgende URL zur Verfügung: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
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.
Sicherheit
basicAuth
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.
Letztmalig online; Datum gemäß ISO 8601.
Filtert danach, ob der Spieler seinen Charakter individuell angepasst hat.
Filtert danach, ob der Spieler im Spiel gekaufte Gegenstände verwendet.
Datum der letzten Kennwortänderung; Datumsangabe gemäß ISO 8601.
Betrag der gewöhnlichen ("non-premium") Währung.
Filtert danach, ob der Spieler den Erhalt von Benachrichtigungen aktiviert hat.
Filtert danach, ob der Spieler auf seinem Profil zusätzliche Informationen hinzugefügt hat.
Filtert danach, ob der Spieler ein Profilbild hochgeladen hat.
Ob der Spieler an PvP-Schlachten (Player versus Player) teilnimmt.
Datum der Kontoerstellung gemäß ISO 8601.
Durchschnittliche Sitzungsdauer, Angabe gemäß ISO 8601.
Filtert danach, ob der Spieler Profile von sozialen Netzwerken verknüpft hat.
Filtert danach, wie oft der Spieler im Chat/Forum gesperrt wurde.
Anzahl der Ingame-Events, an denen der Spieler teilgenommen hat.
Anzahl der Geschenke im Spiel, die der Spieler verschickt/erhalten hat.
Filtert danach, ob der Spieler das Tutorial des Spiels absolviert hat.
Objekt, welches Angaben zum Kauf enthält.
Ob es sich bei dem Artikel um eine Lootbox handelt.
Standard false
Daten zum Abonnement (Objekt).
Abonnement-Modelle (Array), die im Zahlungsportal angezeigt werden sollen.
Währung des Abo-Modells, die bei allen Kalkulationen verwendet werden soll.
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.
Externe ID des Abo-Modells. Diese finden Sie im Kundenportal unter Subscriptions > Abo-Modelle.
Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Benutzer.
Bevorzugte Zahlungswährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.
Transaktions-ID im Spiel. Muss für jede Benutzerzahlung eindeutig sein. Detaillierte Informationen dazu finden Sie in der Dokumentation.
Sprache der Benutzeroberfläche. Sprachencode, bestehend aus 2 Kleinbuchstaben.
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.
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"
Xsolla-ID des Spiels. Kann im Kundenportal eingesehen werden.
Weiterleitungsrichtlinien-Einstellungen (Objekt).
Verzögerung (in Sekunden), nach der ein Benutzer automatisch zur Rückgabe-URL weitergeleitet wird.
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"
Text auf der Schaltfläche für die manuelle Weiterleitung.
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"
Ob auf der Zahlungsstatusseite ein Countdown für die Weiterleitung angezeigt werden soll. Die Dauer des Countdowns hängt von dem Wert ab, der im Parameter settings.redirect_policy.delay übermittelt wird.
Standard false
URL der Seite, zu der ein Benutzer nach dem Bezahlen weitergeleitet wird. Wie Sie Weiterleitungen konfigurieren, erfahren Sie in der Dokumentation.
Schnittstellen-Einstellungen (Objekt).
Alternative Ansicht des Zahlungsportals beim Öffnen. Beispielsweise können priorisierte Zahlungsmethoden angezeigt werden.
Ist apple-pay festgelegt, wird dem Nutzer die Schaltfläche "Apple Pay" als primäre Zahlungsmöglichkeit angezeigt, zusammen mit einem Link, der auf eine Liste der anderen Zahlungsmethoden verweist. Diese Logik gilt nicht für Android- Geräte.
Wert"apple-pay"
Ob die Schaltfläche für die Sofortzahlung per Apple Pay oben im Zahlungsportal auf unterstützten Geräten angezeigt werden soll. Standartwert: true. Ist false festgelegt, wird Apple Pay gemäß dem PayRank-Algorithmus in der Liste der Zahlungsmethoden angezeigt.
Hinweis
Auf Android- und allen anderen Geräten, auf denen eine Zahlung per Apple Pay nicht möglich ist, ist diese Zahlungsmethode unabhängig vom Parameterwert in der Liste der verfügbaren Zahlungsmethoden ausgeblendet.
Menü-Einstellungen (Objekt).
Untermenü "Abo-Modelle" (Objekt).
Untermenü "Virtuelle Währung".
Legt fest, ob der Benutzer eine willkürliche Menge der virtuellen Währung im Zahlungsportal eingeben kann.
settings.ui.components.virtual_currency.hiddenboolean
Legt fest, ob das Untermenü angezeigt wird.
Untermenü "Virtuelle Gegenstände".
settings.ui.components.virtual_items.hiddenboolean
Legt fest, ob das Untermenü angezeigt wird.
Gruppe, die nach dem Öffnen der Registerkarte "Virtuelle Gegenstände" angezeigt wird.
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.
Schnittstellen-Einstellungen für die Desktop-Version (Objekt).
Einstellungen für den Header (Objekt).
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.
Das Symbol der Schließen-Schaltfläche im Zahlungsportal.
| Enum Wert | Beschreibung |
|---|---|
| arrow | Das Symbol ← an der linken Seite der Kopfzeile des Zahlungsportals. |
| cross | Das Symbol × an der rechten Seite der Kopfzeile des Zahlungsportals. |
Legt fest, ob der Header im Zahlungsportal angezeigt wird.
Erscheinungsbild des Headers. Als Wert lässt sich entweder compact (Projektname und Benutzer-ID sind ausgeblendet) oder normal (voreingestellt) festlegen.
Enum"compact""normal"
Ist true festgelegt, wird das Logo im Header angezeigt. Öffnen Sie Ihr Projekt im Kundenportal, und navigieren Sie zu Pay Station > Einstellungen, um das Bild hochzuladen.
Legt fest, ob der Projektname im Header angezeigt wird.
Einstellungen zur Liste der Abo-Modelle (Objekt).
Jeglicher Text, der im Zahlungsportal oberhalb der Liste der verfügbaren Abo-Modelle angezeigt werden soll.
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.
Die Art und Weise, wie die Zahlungsmethode Google Pay angezeigt wird. Ist true festgelegt, wird die Schaltfläche für die Schnellzahlung per Google Pay unabhängig vom Gerät und Browser des Nutzers oben im Zahlungsportal angezeigt. Ist false festgelegt, wird Google Pay gemäß dem PayRank-Algorithmus in der Liste der Zahlungsmethoden angezeigt. Wird der Parameter nicht übermittelt, wird Google Pay oben im Zahlungsportal auf allen Geräten und Browsern angezeigt, außer in Safari – in Safari wird Google Pay in der Liste der Zahlungsmethoden angezeigt.
Wie die Liste der Warenkorbartikel und die Finanzdaten im Zahlungsportal angezeigt werden. Ist true festgelegt, werden die Informationen in einer ausgeklappten Ansicht dargestellt. Wenn false(Standard) festgelegt ist oder der Parameter nicht übermittelt wird, werden die Informationen in einer zusammengeklappten Ansicht dargestellt.
Ob die Benutzer beim Kauf vom im Startprogramm eingebetteten Browser (WebView) zu ihrem Standardbrowser weitergeleitet werden sollen. false ist voreingestellt.
settings.ui.is_language_selector_hiddenboolean(is_language_selector_hidden)
Ob die Sprachauswahl auf der Zahlungsseite ausgeblendet ist. Ist false festgelegt (Standard), wird die Sprachauswahl angezeigt.
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.
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.
settings.ui.is_search_field_hiddenboolean(is_search_field_hidden)
Ob im Zahlungsportal eine Suchleiste für Zahlungsmethoden angezeigt wird. Ist true festgelegt, ist die Suchleiste ausgeblendet. Standardmäßig ist false festgelegt.
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.
Ob die "3-D Secure"-Prüfung in einem neuen Browserfenster geöffnet wird. Legen Sie true fest, wenn Ihr Setup eine Content Security Policy (CSP) vorschreibt.
Standard false
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"
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.
Anzeigemodus des Zahlungsportals zur Verwaltung gespeicherter Zahlungsmethoden. Kann auf user_account gesetzt oder weggelassen werden. In diesem Modus kann der Nutzer nur die Sprache ändern, neue Zahlungsmethoden hinzufügen und bestehende entfernen.
Hinweis
Wenn dieser Parameter übermittelt wird, wird der Weiterleitungs-Button nicht angezeigt. Um einen Nutzer nach dem Speichern der Zahlungsmethode weiterzuleiten, müssen Sie die automatischen Weiterleitungen konfigurieren.
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"
Details zum Benutzerkonto (Objekt).
Abschnitt Gespeicherte Methoden.
Legt fest, ob das Stiftsymbol, das zur Bearbeitungsseite für Zahlungsmethoden weiterleitet, im Zahlungsportal angezeigt werden soll. Standardmäßig ist true festgelegt.
Benutzerdaten (Objekt).
Benutzerattribute zum Filtern der Liste der Gegenstände; repräsentiert durch eine gültige Reihe von JSON-Objekten bestehend aus Schlüssel-Wert-Paaren.
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.
Ländercode, bestehend aus zwei Großbuchstaben gemäß ISO 3166-1 ALPHA-2.
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.
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.
E-Mail-Adresse des Benutzers. Muss gemäß RFC 822-Protokoll gültig sein.
Die bei Ihnen gespeicherte eindeutige Benutzer-ID im Spiel. Stellen Sie sicher, dass Sie die vorhandene Benutzer-ID übermitteln. Falls ein Fehler auftritt, lesen Sie die FAQ.
Objekt mit Angaben zur juristischen Person. Objekt und alle seine Parameter sind erforderlich, falls für user.is_legal true festgelegt ist.
Land des Unternehmenssitzes. Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.
Datenverkehrsattribute (Objekt).
Datenverkehrskanal (kontextbezogene Anzeigen, mediale Anzeigen, E-Mail-Listen, usw.).
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"size": "medium"
}
},
"user": {
"email": {
"value": "email@example.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'Antwort
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }