Zum Inhalt springen
/
Von gespeichertem Konto a...

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

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://xsolla.redocly.app/_mock/de/api/pay-station/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://xsolla.redocly.app/_mock/de/api/pay-station/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.

purchaseobject

Objekt, welches Angaben zum Kauf enthält.

settingsobject

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

userobject

Benutzerdaten (Objekt).

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/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