Zum Inhalt springen

Überblick

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

Diese API-Referenz beschreibt Endpunkte für die Verwaltung von Abonnements, Gutscheinen und Werbeaktionen. Weitere Informationen über Subscriptions finden Sie in der Produktanleitung und in der Begriffserläuterung.

OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/subscriptions/
Operationen

Anfrage

Sie können einen Token mit beliebigen Benutzerparametern erstellen. Diese Parameter senden Sie beim Erhalt des Tokens und erhalten sie nach einer erfolgreichen Zahlung zurück. Ein Token kann nur Parameter enthalten, die entweder in diesem Dokument beschrieben oder von Ihnen vordefiniert sind.

Wenn ein Parameter im falschen Format gesendet wird oder den falschen Typ hat, wird kein Token ausgestellt. Sie erhalten einen 422-HTTP-Code mit der Fehlerbeschreibung im JSON-Body. In extended_message erhalten Sie eine Information, welche genauen Parameter falsch gesendet wurden.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, daher müssen Sie zum Einrichten der Autorisierung den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

Bodyapplication/jsonerforderlich
custom_parametersobject

Sie können zusätzliche Parameter im Token im custom_parameters-Objekt übermitteln, um Betrugsschutzfilter zu konfigurieren. Die empfohlenen Parameter werden in der Drop-down-Liste angezeigt. Siehe Pay-Station-Dokumentation .

purchaseobject

Objekt, welches Angaben zum Kauf enthält.

Beispiel: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
settingsobject

Benutzerdefinierte Projekteinstellungen (Objekt).

Beispiel: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
userobject

Benutzerdaten (Objekt).

Beispiel: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/token' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "checkout": {
        "amount": 10,
        "currency": "USD"
      },
      "subscription": {
        "gift": {
          "email": "recipient_email@email.com",
          "recipient": "test_recipient_v1"
        }
      }
    },
    "settings": {
      "currency": "USD",
      "language": "en",
      "project_id": 16184,
      "ui": {
        "components": {
          "virtual_currency": {
            "custom_amount": true
          }
        },
        "desktop": {
          "virtual_item_list": {
            "button_with_price": true,
            "layout": "list"
          }
        },
        "size": "medium"
      }
    },
    "user": {
      "age": 19,
      "country": {
        "allow_modify": true,
        "value": "US"
      },
      "email": {
        "value": "john.smith@mail.com"
      },
      "id": {
        "value": "user_2"
      },
      "name": {
        "value": "John Smith"
      }
    }
  }'

Antworten

Created.

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