Zum Inhalt springen

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

Token erstellen

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

Händler-ID.

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(purchase)

Objekt, welches Angaben zum Kauf enthält.

settingsobject(settings)

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

userobject(user)

Benutzerdaten (Objekt).

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

Antworten

Created.

Bodyapplication/json
tokenstring
Antwort
application/json
{
  "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}

Tokenisierung

Operationen

Berichte

Operationen

Erstattung

Operationen

Testen

Operationen