Zum Inhalt springen
/
Gespeicherte Konten abruf...

Pay Station API (2.0)

Überblick

  • 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
index.json
index.yaml
Sprachen
Server
https://api.xsolla.com/merchant/v2/
Mock server
https://xsolla.redocly.app/_mock/de/api/pay-station/

Token

Operationen

Tokenisierung

Operationen

Gespeicherte Konten abrufen

Anfrage

Listet die gespeicherten Zahlungskonten eines festgelegten Benutzers auf.

Hinweis

In der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

user_idstringerforderlich

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.

Abfrage
modestring

Legen Sie als Wert sandbox fest, um den Zahlungsvorgang zu testen. Entfernen Sie den Parameter um tatsächliche Zahlungen zu tätigen.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts?mode=string'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "id": 4612345,
    "name": "PP_saved_account",
    "payment_system": { … },
    "type": "paypal"
  }
]

Gespeichertes Zahlungskonto löschen

Anfrage

Löscht ein gespeichertes Zahlungskonto.

Hinweis

In der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion.

Hinweis

Sie können diese API-Methode in der Testumgebung aufrufen. Dafür übermitteln Sie die Testzahlung in der Anforderung. Lesen Sie die Anweisung. Da finden Sie weitere Informationen über die Testumgebung und die Testszenarien.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

user_idstringerforderlich

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.

typestringerforderlich

Zahlungskontotyp.

Enum WertBeschreibung
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hongkong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegererforderlich

ID des gespeicherten Kontos in der Xsolla-Datenbank.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}'

Antworten

No Content.

Von gespeichertem Konto abbuchen

Anfrage

Von einem gespeicherten Zahlungskonto des Benutzers abbuchen.

Hinweis

In der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion.

Hinweis

Damit der API-Aufurf korrekt funktioniert, müssen Sie einen Timeout von 2 Minuten konfigurieren.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

user_idstringerforderlich

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.

typestringerforderlich

Zahlungskontotyp.

Enum WertBeschreibung
alipayplus_boost

Boost.

alipayplus_cn

Alipay.

alipayplus_dana

DANA.

alipayplus_gcash

GCash.

alipayplus_hk

Alipay (Hongkong).

alipayplus_kplus

K PLUS.

alipayplus_maya

Maya.

alipayplus_rabbitlinepay

Rabbit LINE pay.

alipayplus_tng

Touch 'n Go.

alipayplus_truemoney

TrueMoney Wallet.

account_idintegererforderlich

ID des gespeicherten Kontos in der Xsolla-Datenbank.

Bodyapplication/jsonerforderlich
custom_parametersobject(custom_parameters)

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.

custom_parameters.​active_datestring

Letztmalig online; Datum gemäß ISO 8601.

custom_parameters.​additional_verificationboolean

Filtert danach, ob der Spieler Konto-Verifikationsverfahren verwendet.

custom_parameters.​character_customizedboolean

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

custom_parameters.​chat_activityboolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

custom_parameters.​completed_tasksinteger

Anzahl der erledigten Aufgaben bzw. erreichten Ziele.

custom_parameters.​forum_activityboolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

custom_parameters.​items_usedboolean

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

custom_parameters.​karma_pointsinteger

Karma des Spielers.

custom_parameters.​last_change_password_datestring

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

custom_parameters.​non_premium_currencynumber(float)

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

custom_parameters.​notifications_enabledboolean

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

custom_parameters.​profile_completedboolean

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

custom_parameters.​profile_image_addedboolean

Filtert danach, ob der Spieler ein Profilbild hochgeladen hat.

custom_parameters.​pvp_activityboolean

Ob der Spieler an PvP-Schlachten (Player versus Player) teilnimmt.

custom_parameters.​registration_datestring

Datum der Kontoerstellung gemäß ISO 8601.

custom_parameters.​session_timestring

Durchschnittliche Sitzungsdauer, Angabe gemäß ISO 8601.

custom_parameters.​social_networks_addedboolean

Filtert danach, ob der Spieler Profile von sozialen Netzwerken verknüpft hat.

custom_parameters.​total_bansinteger

Filtert danach, wie oft der Spieler im Chat/Forum gesperrt wurde.

custom_parameters.​total_charactersinteger

Anzahl der Charaktere im Spiel.

custom_parameters.​total_clansinteger

Anzahl der Clans, bei denen der Spieler Mitglied ist.

custom_parameters.​total_friendsinteger

Anzahl der Freunde.

custom_parameters.​total_game_eventsinteger

Anzahl der Ingame-Events, an denen der Spieler teilgenommen hat.

custom_parameters.​total_giftsinteger

Anzahl der Geschenke im Spiel, die der Spieler verschickt/erhalten hat.

custom_parameters.​total_hoursinteger

Gesamtzahl der Spielstunden.

custom_parameters.​total_inventory_valuenumber(float)

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

custom_parameters.​total_sumnumber(float)

Gesamtbetrag der Zahlungen.

custom_parameters.​tutorial_completedboolean

Filtert danach, ob der Spieler das Tutorial des Spiels absolviert hat.

custom_parameters.​unlocked_achievementsinteger

Anzahl an freigeschalteten Errungenschaften.

custom_parameters.​user_levelinteger

Level, Ansehen oder Rang des Spielers.

custom_parameters.​win_rateinteger

Gewinnquote.

purchaseobject

Objekt, welches Angaben zum Kauf enthält.

purchase.​checkoutobject

Objekt, welches Angaben zur Bezahlung enthält.

purchase.​checkout.​amountnumber(float)

Kaufbetrag.

purchase.​checkout.​currencystring

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

purchase.​descriptionobject
purchase.​description.​valuestring<= 4000 characters
purchase.​virtual_currencyobject

Objekt, welches Angaben zur virtuellen Währung enthält.

purchase.​virtual_currency.​quantitynumber(float)

Kaufbetrag in der virtuellen Währung.

settingsobject

Objekt, welches die Einstellungen für den Kauf enthält.

settings.​currencystring(currency)

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

settings.​external_idstring(external_id)

Transaktions-ID im Spiel. Muss für jede Benutzerzahlung eindeutig sein. Detaillierte Informationen dazu finden Sie in der Dokumentation.

settings.​mock_codeinteger(mock_code)

Ein zu reproduzierender Fehlercode beim Testen des Zahlungsvorgangs über PayPal in der Testumgebung. Funktioniert nur korrekt, wenn Sie den Parameter "mode":"sandbox" übermitteln.

Enum1002101510391046105710891201120318011803
settings.​modestring

Legen Sie als Wert sandbox fest, um den Zahlungsvorgang auszutesten. Entfernen Sie den Parameter für tatsächliche Zahlungen.

userobject

Benutzerdaten (Objekt).

user.​ipstringerforderlich

IP-Adresse des Benutzers.

user.​legalobject(legal)

Objekt mit Angaben zur juristischen Person.

user.​legal.​addressstring

Vollständige Unternehmensanschrift.

user.​legal.​countrystring

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

user.​legal.​namestring

Vollständiger Name des Unternehmens.

user.​legal.​vat_idstring

Steuerliche Identifikationsnummer.

user.​namestring

Benutzername.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/payments/{type}/{account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "description": {
        "value": "currency purchase"
      },
      "virtual_currency": {
        "quantity": 100
      }
    },
    "settings": {
      "currency": "USD",
      "external_id": "ext123",
      "mode": "sandbox"
    },
    "user": {
      "ip": "111.11.11.11",
      "legal": {
        "address": "17 Crown Street London SW2 0JW United Kingdom",
        "country": "GB",
        "name": "My Awesome Company",
        "vat_id": "GB111111111"
      },
      "name": "John Smith"
    }
  }'

Antworten

Created.

Bodyapplication/json
transaction_idinteger
Antwort
application/json
{
  "transaction_id": 123458390
}

Berichte

Operationen

Erstattung

Operationen

Testen

Operationen