# Pay Station API # Überblick {% #overview %} * **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](/de/doc/pay-station/how-to/how-to-open-payment-ui/). 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](/de/doc/pay-station/features/tokenization/) – 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](/de/solutions/payments/integration-guide/integration-flow/).

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.

Version: 2.0 ## Servers ``` https://api.xsolla.com/merchant/v2 ``` ## Security ### basicAuth Die Xsolla-API nutzt die Basisauthentifizierung. Alle Anfragen an die API müssen den Header `Authorization: Basic ` enthalten, wobei ` Firma** - in der URL in der Adresszeile des Browsers auf einer beliebigen Seite im Kundenportal. Die URL weist das folgende Format auf:  `https://publisher.xsolla.com/`. - Der `api_key` wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird. Sie sind selbst dafür verantwortlich, den Schlüssel zu speichern. Einen neuen Schlüssel können Sie in den folgenden Abschnitten erstellen: - **Firmeneinstellungen > API-Schlüssel** - **Projekteinstellungen > API-Schlüssel** Weitere Informationen zur Handhabung von API-Schlüsseln finden Sie in der [API- Referenz](https://developers.xsolla.com/de/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Pay Station API](https://xsolla.redocly.app/_bundle/@l10n/de/api/pay-station/index.yaml) ## Token ### Token erstellen - [POST /merchants/{merchant_id}/token](https://xsolla.redocly.app/de/api/pay-station/token/create-token.md): 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. HinweisDer 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}. HinweisDieser 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. ### Token ungültig machen - [POST /projects/{project_id}/token/{token}/expire](https://xsolla.redocly.app/de/api/pay-station/token/invalidate-token.md): Erklärt den bestehenden Zahlungstoken für ungültig und verhindert so, dass dieser zum Öffnen des Zahlungsportals verwendet wird. Mit dieser Funktion lassen sich doppelte Zahlungen für einmalig verfügbare Artikel in parallelen Sitzungen vermeiden. Nach erfolgreichem Aufruf verfallen alle anderen Nutzersitzungen, die mit diesem Zahlungstoken geöffnet wurden. HinweisDieser API-Aufruf ist idempotent, er kann also mehrfach hintereinander ausgeführt werden. ## Tokenisierung ### Gespeicherte Konten abrufen - [GET /projects/{project_id}/users/{user_id}/payment_accounts](https://xsolla.redocly.app/de/api/pay-station/tokenization/get-saved-accounts.md): Listet die gespeicherten Zahlungskonten eines festgelegten Benutzers auf. HinweisIn der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion. ### Gespeichertes Zahlungskonto löschen - [DELETE /projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}](https://xsolla.redocly.app/de/api/pay-station/tokenization/delete-saved-account.md): Löscht ein gespeichertes Zahlungskonto. HinweisIn der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion. HinweisSie 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. ### Von gespeichertem Konto abbuchen - [POST /projects/{project_id}/users/{user_id}/payments/{type}/{account_id}](https://xsolla.redocly.app/de/api/pay-station/tokenization/charge-with-saved-account.md): Von einem gespeicherten Zahlungskonto des Benutzers abbuchen. HinweisIn der Testumgebung funktioniert dieser API-Aufruf nur mit Testkarten ohne "3-D Secure"-Funktion. HinweisDamit der API-Aufurf korrekt funktioniert, müssen Sie einen Timeout von 2 Minuten konfigurieren. ## Berichte ### Berichte abrufen - [GET /merchants/{merchant_id}/reports](https://xsolla.redocly.app/de/api/pay-station/reports/get-reports.md): Fordert die Liste der Finanzberichte für einen bestimmten Zeitraum an. HinweisDieser 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. ### Transaktionen abrufen - [GET /merchants/{merchant_id}/reports/transactions/registry.{format}](https://xsolla.redocly.app/de/api/pay-station/reports/get-transactions.md): 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. HinweisDieser 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. ### Transaktionen durchsuchen - [GET /merchants/{merchant_id}/reports/transactions/search.{format}](https://xsolla.redocly.app/de/api/pay-station/reports/find-transactions.md): 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. HinweisDieser 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. ### Transaktion durchsuchen (Schnellsuche) - [GET /merchants/{merchant_id}/reports/transactions/simple_search](https://xsolla.redocly.app/de/api/pay-station/reports/find-transactions-fast.md): Ruft innerhalb weniger Sekunden eine Liste von Transaktionen basierend auf bestimmten Suchparametern ab. Alternative zum API-Aufruf [Transaktionen durchsuchen](/de/api/pay-station/operation/find-transactions/), der Daten im JSON-, CSV- oder XLS-Format zurückgibt. HinweisDieser 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. ### Ruft die Auszahlungen aufgeschlüsselt nach Währung ab - [GET /merchants/{merchant_id}/reports/transactions/summary/transfer](https://xsolla.redocly.app/de/api/pay-station/reports/get-payouts-breakdown.md): Ruft die Aufschlüsselung der Auszahlungen in der Währung ab. HinweisDieser 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. ### Transaktion abrufen - [GET /merchants/{merchant_id}/reports/transactions/{transaction_id}/details](https://xsolla.redocly.app/de/api/pay-station/reports/get-transaction.md): Ruft die vollständigen Transaktionsdaten mittels ID ab. HinweisDieser 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. ### Auszahlungen abrufen - [GET /merchants/{merchant_id}/reports/transfers](https://xsolla.redocly.app/de/api/pay-station/reports/get-payouts.md): Listet alle Auszahlungen für einen Zeitraum auf. HinweisDieser 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. ## Erstattung ### Teilerstattung - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund](https://xsolla.redocly.app/de/api/pay-station/refund/request-partial-refund.md): Sendet einen Antrag auf Teilerstattung an einen Benutzer. Ausführliche Informationen über den Erstattungsvorgang und die Zahlungsmethoden, die Teilerstattungen unterstützen, finden Sie in unserer Dokumentation. HinweisSie 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. HinweisDieser 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. ### Komplette Erstattung - [PUT /merchants/{merchant_id}/reports/transactions/{transaction_id}/refund](https://xsolla.redocly.app/de/api/pay-station/refund/request-refund.md): Sendet eine Rückerstattungsanforderung, um eine Zahlung an einen Benutzer zurückzugeben. Lesen Sie über [die Rückerstattungsfunktion](https://developers.xsolla.com/de/doc/pay-station/features/refund/), um mehr über den Vorgang zu erfahren. HinweisSie 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. HinweisDieser 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. ## Testen ### Rückbuchung anfordern - [POST /merchants/{merchant_id}/projects/{project_id}/payments/{transaction_id}/chargeback](https://xsolla.redocly.app/de/api/pay-station/testing/request-chargeback.md): Fordert Rückbuchung in der Testumgebung an: - Um zur Testumgebung zu gelangen, übermitteln Sie "mode":"sandbox", wenn Sie den Token erhalten. - Die Testzahlung muss in der Testumgebung des gleichen Projekts gemacht werden, das Sie zum Testen nutzen. - Der Transaktionsstatus muss auf darf nicht refunded, cancelledsein. - Ihre Rolle im Kundenportal muss mindestens Finanzmanager sein. (Sie können das im Bereich Firmeneinstellungen > Benutzer finden.) - Lesen Sie die Anweisung. Da finden Sie weitere Informationen über dieses Testszenario. HinweisLesen Sie die Dokumentation. Da finden Sie weitere Informationen über andere Testszenarien.