Zum Inhalt springen
/
Komplette Erstattung

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

Erstattung

Operationen

Teilerstattung

Anfrage

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.

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.

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.

Bodyapplication/jsonerforderlich
descriptionstring<= 4000 characterserforderlich

Grund für die Erstattung.

refund_amountnumber(float)erforderlich

Erstattungsbetrag in einer Kaufwährung.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request",
    "refund_amount": 1.5
  }'

Antworten

Antrag auf Erstattung angenommen

Antwort
Kein Inhalt

Komplette Erstattung

Anfrage

Sendet eine Rückerstattungsanforderung, um eine Zahlung an einen Benutzer zurückzugeben. Lesen Sie über die Rückerstattungsfunktion, um mehr über den Vorgang zu erfahren.

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.

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.

Bodyapplication/jsonerforderlich
descriptionstring<= 4000 characterserforderlich

Grund für die Erstattung.

emailstring<= 100 characters

E-Mail des Benutzers.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "test refund request"
  }'

Antworten

OK (Kein Fehler).

Bodyapplication/json
messagestring

Kann eine der folgenden Meldungen anzeigen:

  • No content.
  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds.
Antwort
application/json
{
  "message": "The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user's method does not support direct refunds."
}

Testen

Operationen