Zum Inhalt springen
/
Ruft die Auszahlungen auf...

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

Berichte

Operationen

Berichte abrufen

Anfrage

Fordert die Liste der Finanzberichte für einen bestimmten Zeitraum an.

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.

Abfrage
datetime_fromstring(datetime)erforderlich

Beginn des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:

  • transfer_id
  • report_id

Beispiel: datetime_from=2023-02-08
datetime_tostring(datetime)erforderlich

Ende des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:

  • transfer_id
  • report_id
Der Zeitraum zwischen datetime_from und datetime_to darf maximal 92 Tage betragen.

Beispiel: datetime_to=2023-03-08
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports?datetime_from=2023-02-08&datetime_to=2023-03-08'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "agreement_document_id": "Organization Inc_RUB",
    "currency": "RUB",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57613,
    "year": 2019
  },
  {
    "agreement_document_id": "Organization Inc_EUR",
    "currency": "USD",
    "is_direct_payout": false,
    "is_draft_by_agreement": true,
    "month": "January",
    "report_id": 57619,
    "year": 2019
  }
]

Transaktionen abrufen

Anfrage

Gibt eine Liste mit detaillierten Informationen zu erfolgreichen und abgebrochenen Transaktionen für einen bestimmten Zeitraum zurück. In der Antwort sind Zahlungsinformationen aufgeführt, einschließlich Daten zu Gebühren, Steuern, Bestellungen und Nutzern. Sie können die Liste im JSON- oder CSV-Format abrufen. Sie können diesen API-Aufruf verwenden, um einen Finanzabgleich durchzuführen.

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.

formatstringerforderlich

Datenformat.

Enum"json""csv""xls"
Abfrage
datetime_fromstring(datetime)erforderlich

Beginn des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:

  • transfer_id
  • report_id

Beispiel: datetime_from=2023-02-08
datetime_tostring(datetime)erforderlich

Ende des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:

  • transfer_id
  • report_id
Der Zeitraum zwischen datetime_from und datetime_to darf maximal 92 Tage betragen.

Beispiel: datetime_to=2023-03-08
in_transfer_currencyintegererforderlich

Konvertiert alle Finanzdaten in die Auszahlungswährung (standardmäßig wird die Einzahlungswährung verwendet). Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:

  • transfer_id
  • report_id

show_totalboolean

Ob der Gesamtbetrag der Transaktionen im Bericht enthalten sein soll. Nur für den Export im CSV-Format verfügbar. Standardwert ist true.

merchant_of_recordsstring or null

Merchant of Record. Kann xsolla, merchant oder nicht spezifiziert sein. Wenn merchant festgelegt ist, werden Transaktionen zurückgegeben, die über die Gateways des Partners abgewickelt wurden. Wenn xsolla festgelegt ist, werden Transaktionen zurückgegeben, die nicht über die Gateways des Partners abgewickelt wurden. Wenn nichts angegeben ist, werden alle Transaktionen zurückgegeben.

Enum WertBeschreibung
merchant

Gibt Transaktionen zurück, die über die Gateways des Partners getätigt wurden.

xsolla

Gibt Transaktionen zurück, die nicht über die Gateways des Partners getätigt wurden.

project_idinteger

Projekt-ID.

show_dry_runboolean

Legt fest, ob testweise durchgeführte Transaktionen miteinbezogen werden.

transfer_idinteger

ID der Auszahlung.

report_idinteger

ID des Finanzberichts.

offsetinteger

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

limitinteger

Das Limit für die Anzahl der angezeigten Transaktionen auf der Seite. Wird dieser Parameter übermittelt, brauchen Sie die Parameter datetime_from und datetime_to nicht zu übermitteln.

statusstring

Status der Transaktion.

Enum"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=2023-02-08&datetime_to=2023-03-08&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'

Antworten

Die Liste der Transaktionen wurde erfolgreich zurückgegeben.

Bodyapplication/jsonArray [
payment_detailsobject

Zahlungsdaten.

purchaseobject

Kaufdaten.

transactionobject

Transaktionsdaten.

userobject

Benutzerdaten (Objekt).

user_balanceobject

Benutzerguthaben.

]
Antwort
application/json
[
  {
    "payment_details": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … },
    "user_balance": { … }
  }
]

Transaktionen durchsuchen

Anfrage

Gibt eine Liste von Transaktionen basierend auf bestimmten Suchparametern zurück. In der Antwort sind Daten zu allen in Ihrem Spiel getätigten Zahlungen aufgeführt, auch wenn diese nicht erfolgreich abgeschlossen wurden. Sie können nicht nur den Transaktionszeitraum festlegen, sondern auch andere Parameter, z.  B. um nach Transaktionen eines bestimmten Nutzers oder mit einem bestimmten Zahlungsstatus zu suchen. Sie können die Liste im JSON- oder CSV-Format abrufen.

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.

formatstringerforderlich

Datenformat.

Enum"json""csv""xls"
Abfrage
datetime_fromstring(datetime)

Beginn des Zeitraums.

datetime_tostring(datetime)

Ende des Zeitraums.

project_idinteger

Projekt-ID.

transaction_idinteger

Transaktions-ID.

typestring

In den Suchergebnissen angezeigte Transaktionsart:

Enum WertBeschreibung
all

Alle Transaktionen.

canceled

Stornierte Transaktionen ohne Testtransaktionen.

test

Testtransaktionen.

transferred

Erfolgreiche Transaktionen ohne Testtransaktionen.

phonestring

Telefonnummer des Benutzers (im internationalen Format).

user_idstring

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.

user_namestring

Benutzername.

user_customstring

Benutzerdefinierte Parameter zur Benutzeridentifikation.

emailstring<= 100 characters

E-Mail des Benutzers.

external_idstring

Transaktions-ID im Spiel. Eine individuelle ID pro Benutzerzahlung erforderlich.

order_idinteger

Bestell-ID. Sie dient zum Aufruf der API-Methode Bestellung abrufen.

Beispiel: order_id=1234
offsetinteger

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

limitinteger

Begrenzung der Elementanzahl auf der Seite.

statusstring(status.enum)

Ein Transaktionsstatus.

Enum WertBeschreibung
awaitingRefund

Entscheidung über die Erstattung ausstehend. Nachdem der Nutzer eine Erstattung beantragt hat, bearbeitet der Xsolla-Kundensupport den Antrag manuell und entscheidet über die Erstattung.

canceled

Es gibt zwei mögliche Szenarien:

  • Die Transaktion wurde seitens des Zahlungssystems storniert. Zum Beispiel, weil das Nutzerkonto nicht ausreichend gedeckt ist.
  • Dem Nutzer wurde der Betrag erstattet.
created

Der Nutzer hat die Transaktion initiiert, sie wurde aber noch nicht verarbeitet.

done

Die Transaktion wurde erfolgreich verarbeitet.

error

Bei der Verarbeitung der Transaktion ist ein Fehler aufgetreten. Solche Zahlungen können durch Kontaktaufnahme mit dem Xsolla-Kundenservice erstattet werden.

partiallyRefunded

Dem Nutzer wurde ein Teil des Betrags erstattet.

processing

Die Transaktion wird verarbeitet.

refunded

Der zu erstattende Betrag wurde dem Xsolla-Guthaben des Nutzers gutgeschrieben.

review

Die Transaktionsverarbeitung wurde vom Betrugsbekämpfungssystem ausgesetzt, die Transaktion wird derzeit geprüft.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/search.{format}?datetime_from=string&datetime_to=string&project_id=0&transaction_id=0&type=all&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&order_id=1234&offset=0&limit=0&status=created'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "payment_details": { … },
    "payment_system": { … },
    "purchase": { … },
    "transaction": { … },
    "user": { … }
  }
]

Transaktion durchsuchen (Schnellsuche)

Anfrage

Ruft innerhalb weniger Sekunden eine Liste von Transaktionen basierend auf bestimmten Suchparametern ab. Alternative zum API-Aufruf Transaktionen durchsuchen, der Daten im JSON-, CSV- oder XLS-Format zurückgibt.

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.

Abfrage
transaction_idinteger

Transaktions-ID. Es muss entweder diese ID oder die external_id angegeben werden, aber nicht beides.

external_idstring

Transaktions-ID im Spiel. Ist für jede Zahlung eindeutig. Es muss entweder diese ID oder die transaction_id angegeben werden, aber nicht beides.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/simple_search?transaction_id=0&external_id=string'

Antworten

Die Liste der Transaktionen wurde erfolgreich zurückgegeben.

Bodyapplication/jsonArray [
payment_detailsobject

Zahlungsdaten.

transactionobject

Transaktionsdetails.

userobject

Benutzerdaten (Objekt).

]
Antwort
application/json
[
  {
    "payment_details": { … },
    "transaction": { … },
    "user": { … }
  }
]

Ruft die Auszahlungen aufgeschlüsselt nach Währung ab

Anfrage

Ruft die Aufschlüsselung der Auszahlungen in der Währung ab.

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.

Abfrage
datetime_fromstring(datetime)

Beginn des Zeitraums.

datetime_tostring(datetime)

Ende des Zeitraums.

legal_entity_idinteger

ID des Rechtssubjekts, das zum Entwickler gehört.

statusstring

Status der Transaktion.

Enum"done""canceled""error""refunded"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/summary/transfer?datetime_from=string&datetime_to=string&legal_entity_id=0&status=done'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "DirectTaxesOfPayments": 0.46,
    "IsoCurrency": "RUB",
    "PaymentsAmount": 223679.84,
    "SumCommissionAgent": 11329.58,
    "SumCommissionUserTaxes": 153.67,
    "SumItems": 571325.13,
    "SumNominalSum": 214792.98,
    "SumOutProject": 551096.13,
    "SumPayoutSum": 193316.71,
    "TaxesOfPayments": 171.56
  },
  {
    "DirectTaxesOfPayments": 0.14,
    "IsoCurrency": "USD",
    "PaymentsAmount": 482.58,
    "SumCommissionAgent": 77.51,
    "SumCommissionUserTaxes": 0.07,
    "SumItems": 243777.62,
    "SumNominalSum": 493.09,
    "SumOutProject": 241787.62,
    "SumPayoutSum": 462.62,
    "TaxesOfPayments": 0.14
  },
  {
    "DirectTaxesOfPayments": 0.07,
    "IsoCurrency": "EUR",
    "PaymentsAmount": 608.2,
    "SumCommissionAgent": 55.71,
    "SumCommissionUserTaxes": 90.94,
    "SumItems": 156238.62,
    "SumNominalSum": 607.26,
    "SumOutProject": 156158.62,
    "SumPayoutSum": 460.8,
    "TaxesOfPayments": 90.94
  }
]

Transaktion abrufen

Anfrage

Ruft die vollständigen Transaktionsdaten mittels ID ab.

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.

transaction_idintegererforderlich

Transaktions-ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/details'

Antworten

Die Transaktionsinformationen wurden erfolgreich zurückgegeben.

Bodyapplication/jsonArray [
customer_detailsobject
finance_detailsobject
payment_detailsobject
subscription_detailsobject
transaction_detailsobject
]
Antwort
application/json
[
  {
    "customer_details": { … },
    "finance_details": { … },
    "payment_details": { … },
    "subscription_details": { … },
    "transaction_details": { … }
  }
]

Auszahlungen abrufen

Anfrage

Listet alle Auszahlungen für einen Zeitraum auf.

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.

Abfrage
datetime_fromstring(datetime)

Beginn des Zeitraums.

datetime_tostring(datetime)

Ende des Zeitraums.

legal_entity_idinteger

ID des Rechtssubjekts, das zum Entwickler gehört.

statusstring

Auszahlungsstatus.

Enum WertBeschreibung
hold

Warten auf eine Anfrage, um fortfahren zu dürfen

paid

Auszahlung abgeschlossen.

ready

Auszahlung läuft.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transfers?datetime_from=string&datetime_to=string&legal_entity_id=0&status=hold'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "canceled": 0,
    "payout": { … },
    "rate": 1,
    "transfer": { … }
  }
]

Erstattung

Operationen

Testen

Operationen