openapi: 3.0.0
info:
  description: "# Überblick\n\n* **Version:** 2.0.0\n* **Server**:\n  * `https://api.xsolla.com/api`\n\nPay Station ist eine bequeme Benutzeroberfläche für Ingame-Käufe, dank derer \ndie Partner ihre Produkte monetarisieren können. Wie Sie die Benutzeroberfläche \n(das \"Zahungsportal\") öffnen können, erfahren Sie in dieser [Anleitung](/de/doc/pay-station/how-to/how-to-open-payment-ui/).\n\nDie Pay Station API umfasst die folgenden Gruppen von API-Aufrufen:\n- Token\_– enthält einen API-Aufruf, mit dem sich ein Token samt beliebigen \n  Nutzerparametern für die weitere Zahlungsverarbeitung über das Zahlungsportal \n  generieren lässt.\n- [Tokenisierung](/de/doc/pay-station/features/tokenization/)\_– enthält API-Aufrufe, \n  mit denen sich Zahlungen sicher verarbeiten lassen, ohne das Zahlungsportal zu \n  öffnen oder den Nutzer einzubeziehen.\n- Berichte\_– enthält API-Aufrufe, mit denen sich Daten zu Nutzertransaktionen \n  abrufen, Berichte generieren und Auszahlungen nach Währung aufschlüsseln lassen.\n- Erstattung\_– enthält API-Aufrufe, mit denen sich Geldbeträge komplett oder \n  teilweise erstatten lassen.\n- Testen\_– enthält einen API-Aufruf, mit dem sich der Rückbuchungsprozess testen \n  lässt.\n\nDetaillierte Informationen dazu, wie man das Zahlungsportal konfiguriert, \nfinden Sie im [Integrationsleitfaden für die Payments-\nLösung](/de/solutions/payments/integration-guide/integration-flow/).\n\n<div class=\"note\">\n<p><strong>Hinweis</strong></p><p>Auch in der <a href=\"https://github.com/xsolla/xsolla-postman\">Postman collection</a> im Abschnitt <b>Xsolla Base API</b> finden sich Informationen dazu, wie man die bei der Integration genutzten API-Aufrufe testet.</p>\n</div>\n"
  title: Pay Station API
  version: '2.0'
servers:
  - url: https://api.xsolla.com/merchant/v2
tags:
  - name: token
    x-displayName: Token
  - name: tokenization
    x-displayName: Tokenisierung
  - name: reports
    x-displayName: Berichte
  - name: refund
    x-displayName: Erstattung
  - name: testing
    x-displayName: Testen
paths:
  /merchants/{merchant_id}/projects/{project_id}/payments/{transaction_id}/chargeback:
    post:
      description: >
        Fordert Rückbuchung in der Testumgebung an:


        - Um zur Testumgebung zu gelangen, übermitteln Sie `"mode":"sandbox"`,
        wenn Sie 
          [den Token](https://developers.xsolla.com/de/api/pay-station/operation/create-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`,
        `cancelled`sein.


        - Ihre Rolle im Kundenportal muss mindestens **Finanzmanager** sein.
        (Sie können 
          das im Bereich **Firmeneinstellungen > Benutzer** finden.)

        - Lesen Sie die <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing
          /test-one-time-purchase-in-
          sandbox/#pay_station_testing_sandbox_bank_card_chargeback">Anweisung</a>. Da 
          finden Sie weitere Informationen über dieses Testszenario.

        <div class="note">

        <p><strong>Hinweis</strong></p><p>Lesen Sie die <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/general-info/">Dokumentation</a>.
        Da finden Sie weitere Informationen über andere Testszenarien.</p>

        </div>
      operationId: request-chargeback
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/project-id-path-param'
        - $ref: '#/components/parameters/transaction-id-path-param'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/empty-body'
        required: true
      responses:
        '204':
          description: No Content (No error).
        '404':
          description: Transaction Not Found.
        '422':
          content:
            application/json:
              example:
                message: >-
                  Not test payment. Chargeback is possible only for payments
                  made in sandbox mode.
              schema:
                properties:
                  message:
                    description: >-
                      Es gibt folgende Antwortmöglichkeiten:

                      - Error processing chargeback. Try again or use another
                      payment.

                      - Payment not found. Check payment ID.

                      - Payment does not belong to this project.

                      - Not test payment. Chargeback is possible only for
                      payments made in sandbox mode.

                      - Incorrect payment status. Chargeback is possible only
                      for payments with “Completed” status.
                    type: string
                type: object
          description: Unprocessable Entity (Invalid request parameters).
      security:
        - basicAuth: []
      summary: Rückbuchung anfordern
      tags:
        - testing
      x-server: true
  /merchants/{merchant_id}/reports:
    get:
      description: >
        Fordert die Liste der Finanzberichte für einen bestimmten Zeitraum an.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: get-reports
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/datetime-from-req'
        - $ref: '#/components/parameters/datetime-to-req'
      responses:
        '200':
          content:
            application/json:
              example:
                - 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
          description: OK.
      security:
        - basicAuth: []
      summary: Berichte abrufen
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/registry.{format}:
    servers:
      - url: https://api.xsolla.com/merchant/v3
    get:
      description: >
        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.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: get-transactions
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/format'
        - $ref: '#/components/parameters/datetime-from-req'
        - $ref: '#/components/parameters/datetime-to-req'
        - $ref: '#/components/parameters/in-transfer-currency'
        - $ref: '#/components/parameters/show-total'
        - $ref: '#/components/parameters/merchant-of-records'
        - $ref: '#/components/parameters/project-id-query-param'
        - $ref: '#/components/parameters/show-dry-run'
        - $ref: '#/components/parameters/transfer-id'
        - $ref: '#/components/parameters/report-id'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit-req'
        - $ref: '#/components/parameters/transaction-status'
      responses:
        '200':
          content:
            application/json:
              example:
                - payment_details:
                    chargebackPenalty:
                      amount: 0
                    commission_agent:
                      amount: 0
                      percent: 0
                    commission_agent_fixed: 0
                    commission_ps:
                      amount: 0
                      fixed_amount: 0
                      percent: 0
                    commission_ps_from_vat:
                      amount: 0
                    commission_user:
                      amount: 0.01
                      percent: 33.33
                    commission_xsolla:
                      amount: 0
                      fixed_amount: 0
                      percent: 5
                    cpa_network_commission:
                      amount: 0
                      percent: 0
                    direct_wht:
                      amount: 0
                      percent: 0
                    payment:
                      amount: 0.03
                      amount_from_ps: 0
                      currency: USD
                    payout:
                      amount: 0.02
                      amount_from_ps: 0
                      currency: RUB
                      fx_rate: 64.1386407767
                      percent: 100
                    refundPenalty:
                      amount: 0
                    repatriation_costs:
                      amount: 0
                      percent: 0
                    sales_tax:
                      amount: 0
                      percent: 0
                    vat:
                      amount: 0
                      percent: 0
                      user_amount: 0
                      user_percent: 0
                  purchase:
                    friend:
                      email: null
                      user_id: null
                    items_amount: 1
                    pin_codes:
                      amount: null
                      content: null
                      currency: null
                    purchase_amount: 0.02
                    simple_checkout:
                      amount: null
                      currency: null
                    subscription:
                      name: null
                      plan_id: null
                      product_id: null
                      product_name: null
                      subscription_id: null
                    virtual_currency:
                      amount: 0.02
                      currency: USD
                    virtual_currency_amount: 1
                    virtual_items:
                      amount: null
                      content: null
                      currency: null
                  transaction:
                    custom_parameters: null
                    direct_account: 0
                    dry_run: 0
                    external_id: null
                    id: 418756634
                    payment_method:
                      class: Digital Payment Methods
                      id: 2760
                      name: Your Balance
                    project:
                      id: 21092
                      name: Smith
                    refund_reason: null
                    refund_reason_comment: null
                    status: done
                    transfer_date: '2019-02-11T13:32:00+03:00'
                  user:
                    country: US
                    custom: null
                    email: email@example.com
                    id: smith123
                    ip: 209.11.22.33
                    marketplace: Pay Station
                    name: Tom
                    phone: null
                  user_balance:
                    payment_currency:
                      deduction_amount: 0
                      payout_amount_from_balance: 0.02
                      purchase_amount_from_balance: 0.02
              schema:
                items:
                  properties:
                    payment_details:
                      description: Zahlungsdaten.
                      properties:
                        chargebackPenalty:
                          properties:
                            amount:
                              format: float
                              type: number
                          type: object
                        commission_agent:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        commission_agent_fixed:
                          type: integer
                        commission_ps:
                          properties:
                            amount:
                              format: float
                              type: number
                            fixed_amount:
                              type: integer
                            percent:
                              format: float
                              type: number
                          type: object
                        commission_ps_from_vat:
                          properties:
                            amount:
                              format: float
                              type: number
                          type: object
                        commission_user:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        commission_xsolla:
                          properties:
                            amount:
                              format: float
                              type: number
                            fixed_amount:
                              type: integer
                            percent:
                              format: float
                              type: number
                          type: object
                        cpa_network_commission:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        direct_wht:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        payment:
                          properties:
                            amount:
                              format: float
                              type: number
                            amount_from_ps:
                              type: integer
                            currency:
                              type: string
                          type: object
                        payout:
                          properties:
                            amount:
                              format: float
                              type: number
                            amount_from_ps:
                              format: float
                              type: number
                            currency:
                              type: string
                            fx_rate:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        refundPenalty:
                          properties:
                            amount:
                              format: float
                              type: number
                          type: object
                        repatriation_costs:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        sales_tax:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                          type: object
                        vat:
                          properties:
                            amount:
                              format: float
                              type: number
                            percent:
                              format: float
                              type: number
                            user_amount:
                              type: integer
                            user_percent:
                              type: integer
                          type: object
                      type: object
                    purchase:
                      description: Kaufdaten.
                      properties:
                        friend:
                          properties:
                            email:
                              nullable: true
                              type: string
                            user_id:
                              nullable: true
                              type: string
                          type: object
                        items_amount:
                          type: integer
                        pin_codes:
                          properties:
                            amount:
                              format: float
                              nullable: true
                              type: number
                            content:
                              nullable: true
                              type: string
                            currency:
                              nullable: true
                              type: string
                          type: object
                        purchase_amount:
                          format: float
                          type: number
                        simple_checkout:
                          properties:
                            amount:
                              format: float
                              nullable: true
                              type: number
                            currency:
                              nullable: true
                              type: string
                          type: object
                        subscription:
                          properties:
                            name:
                              nullable: true
                              type: string
                            plan_id:
                              nullable: true
                              type: integer
                            product_id:
                              nullable: true
                              type: string
                            product_name:
                              nullable: true
                              type: string
                            subscription_id:
                              nullable: true
                              type: integer
                          type: object
                        virtual_currency:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        virtual_currency_amount:
                          type: integer
                        virtual_items:
                          properties:
                            amount:
                              format: float
                              nullable: true
                              type: number
                            content:
                              nullable: true
                              type: string
                            currency:
                              nullable: true
                              type: string
                          type: object
                      type: object
                    transaction:
                      description: Transaktionsdaten.
                      properties:
                        custom_parameters:
                          nullable: true
                          type: object
                        direct_account:
                          type: integer
                        dry_run:
                          type: integer
                        external_id:
                          nullable: true
                          type: string
                        id:
                          type: integer
                        payment_method:
                          properties:
                            class:
                              type: string
                            id:
                              type: integer
                            name:
                              type: string
                          type: object
                        project:
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                          type: object
                        refund_reason:
                          nullable: true
                          type: string
                        refund_reason_comment:
                          nullable: true
                          type: string
                        status:
                          enum:
                            - created
                            - processing
                            - done
                            - canceled
                            - error
                            - refunded
                            - partiallyRefunded
                            - awaitingRefund
                            - disputeFee
                          type: string
                        transfer_date:
                          format: datetime
                          type: string
                      type: object
                    user:
                      description: Benutzerdaten (Objekt).
                      properties:
                        country:
                          description: >-
                            Ländercode, bestehend aus 2 Großbuchstaben gemäß
                            [ISO 3166-1
                            ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
                          type: string
                        custom:
                          nullable: true
                          type: string
                        email:
                          description: E-Mail des Benutzers.
                          type: string
                        id:
                          description: Benutzer-ID.
                          type: string
                        ip:
                          type: string
                        marketplace:
                          type: string
                        name:
                          description: Benutzername.
                          type: string
                        phone:
                          description: Telefonnummer des Benutzers.
                          nullable: true
                          type: string
                      type: object
                    user_balance:
                      description: Benutzerguthaben.
                      properties:
                        payment_currency:
                          description: Bevorzugte Zahlungswährung.
                          properties:
                            deduction_amount:
                              format: float
                              type: number
                            payout_amount_from_balance:
                              format: float
                              type: number
                            purchase_amount_from_balance:
                              format: float
                              type: number
                          type: object
                      type: object
                  type: object
                type: array
          description: Die Liste der Transaktionen wurde erfolgreich zurückgegeben.
      security:
        - basicAuth: []
      summary: Transaktionen abrufen
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/search.{format}:
    get:
      description: "Gibt eine Liste von Transaktionen basierend auf bestimmten Suchparametern \nzurück. In der Antwort sind Daten zu allen in Ihrem Spiel getätigten Zahlungen \naufgeführt, auch wenn diese nicht erfolgreich abgeschlossen wurden. Sie können \nnicht nur den Transaktionszeitraum festlegen, sondern auch andere Parameter, z.\_\nB. um nach Transaktionen eines bestimmten Nutzers oder mit einem bestimmten \nZahlungsstatus zu suchen. Sie können die Liste im JSON- oder CSV-Format abrufen.\n\n<div class=\"notice\">\n<p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.</p>\n</div>\n"
      operationId: find-transactions
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/format'
        - $ref: '#/components/parameters/datetime-from'
        - $ref: '#/components/parameters/datetime-to'
        - $ref: '#/components/parameters/project-id-query-param'
        - $ref: '#/components/parameters/transaction-id'
        - $ref: '#/components/parameters/type'
        - $ref: '#/components/parameters/phone'
        - $ref: '#/components/parameters/user-id-query-param'
        - $ref: '#/components/parameters/user-name'
        - $ref: '#/components/parameters/user-custom'
        - $ref: '#/components/parameters/email'
        - $ref: '#/components/parameters/external-id'
        - $ref: '#/components/parameters/order-id'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/status'
      responses:
        '200':
          content:
            application/json:
              example:
                - payment_details:
                    payment:
                      amount: 7.96
                      amount_from_ps: 7.96
                      currency: RUB
                    sales_tax:
                      amount: 0
                      percent: 0
                  payment_system:
                    decline_reason: null
                  purchase:
                    pin_codes:
                      amount: null
                      content: null
                      currency: null
                    simple_checkout:
                      amount: 7.96
                      currency: RUB
                    subscription:
                      name: null
                    virtual_currency:
                      amount: 0
                      name: null
                    virtual_items: null
                  transaction:
                    create_date: '2021-10-20'
                    dry_run: 0
                    external_id: example-external-id
                    id: 123456789
                    is_refund_allowed: 0
                    order_id: 1234
                    payment_method:
                      id: 1
                      name: PayPal
                    project:
                      id: 123456
                      name: Example
                    refund_reason: null
                    status: done
                    transfer_date: '2021-10-20'
                  user:
                    country: RU
                    custom: null
                    email: email@example.com
                    id: example-id
                    name: Example
                    phone: null
          description: OK.
      security:
        - basicAuth: []
      summary: Transaktionen durchsuchen
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/simple_search:
    get:
      description: >
        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.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: find-transactions-fast
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - description: >-
            Transaktions-ID. Es muss entweder diese ID oder die `external_id`
            angegeben werden, aber nicht beides.
          in: query
          name: transaction_id
          schema:
            type: integer
        - description: >-
            Transaktions-ID im Spiel. Ist für jede Zahlung eindeutig. Es muss
            entweder diese ID oder die `transaction_id` angegeben werden, aber
            nicht beides.
          in: query
          name: external_id
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                - payment_details:
                    payment:
                      amount: 7.96
                      currency: BRL
                  transaction:
                    external_id: example_external_id_123
                    id: 123456
                    payment_date: '2023-02-11 15:32:46'
                    project:
                      id: 123456
                      name: Test
                    status: done
                  user:
                    country: BR
                    email: email@example.com
                    id: '123456'
                    name: John Smith
              schema:
                items:
                  properties:
                    payment_details:
                      description: Zahlungsdaten.
                      properties:
                        payment:
                          properties:
                            amount:
                              description: Zahlungsbetrag.
                              format: float
                              type: number
                            currency:
                              description: >-
                                Zahlungswährung. Währungscode, bestehend aus
                                drei Buchstaben gemäß [ISO
                                4217](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/).
                              type: string
                          type: object
                      type: object
                    transaction:
                      description: Transaktionsdetails.
                      properties:
                        external_id:
                          description: >-
                            Transaktions-ID im Spiel. Ist für jede Zahlung
                            eindeutig.
                          type: string
                        id:
                          description: Transaktions-ID.
                          type: integer
                        payment_date:
                          description: 'Zahlungsdatum im Format: JJ-MM-DD.'
                          type: string
                        project:
                          properties:
                            id:
                              description: >-
                                Xsolla-ID des Spiels. Kann im Kundenportal
                                eingesehen werden.
                              type: integer
                            name:
                              description: Projektname.
                              type: string
                          type: object
                        refund_reason:
                          description: Grund für die Rückerstattung.
                          type: string
                        status:
                          $ref: '#/components/schemas/status.enum'
                          description: Status der Transaktion.
                      type: object
                    user:
                      description: Benutzerdaten (Objekt).
                      properties:
                        country:
                          description: >-
                            Ländercode, bestehend aus zwei Großbuchstaben gemäß
                            [ISO 3166-1
                            ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
                          type: string
                        email:
                          description: E-Mail des Benutzers.
                          type: string
                        id:
                          description: Benutzer-ID.
                          type: string
                        name:
                          description: Benutzername.
                          type: string
                      type: object
                  type: object
                type: array
          description: Die Liste der Transaktionen wurde erfolgreich zurückgegeben.
        '403':
          description: Access Denied.
        '404':
          description: Transaction Not Found.
        '422':
          description: >-
            Unprocessable Entity (Sie müssen entweder die `transaction_id` oder
            die `external_id` übermitteln).
      security:
        - basicAuth: []
      summary: Transaktion durchsuchen (Schnellsuche)
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/summary/transfer:
    get:
      description: >
        Ruft die Aufschlüsselung der Auszahlungen in der Währung ab.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: get-payouts-breakdown
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/datetime-from'
        - $ref: '#/components/parameters/datetime-to'
        - $ref: '#/components/parameters/legal-entity-id'
        - $ref: '#/components/parameters/transaction-status'
      responses:
        '200':
          content:
            application/json:
              example:
                - 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
          description: OK.
      security:
        - basicAuth: []
      summary: Ruft die Auszahlungen aufgeschlüsselt nach Währung ab
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/{transaction_id}/details:
    get:
      description: >
        Ruft die vollständigen Transaktionsdaten mittels ID ab.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: get-transaction
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/transaction-id-path-param'
      responses:
        '200':
          content:
            application/json:
              example:
                - customer_details:
                    billing_address: ''
                    bin: ''
                    browser_language: ''
                    country: US
                    ip: 209.11.22.33
                    paystation_country: ''
                    phone: null
                    timezone: ''
                    user_id: user1
                    user_name: John Smith
                  finance_details:
                    direct_wht:
                      amount: 0
                      currency: USD
                    dispute_fee:
                      amount: 70
                      currency: USD
                      date: '2019-04-20 16:15:37'
                    payment:
                      amount: 0.04
                      currency: USD
                    payment_method_fee:
                      amount: 0.01
                      currency: USD
                    payment_method_sum:
                      amount: 0.04
                      currency: USD
                    payout:
                      amount: 1.25
                      currency: RUB
                    payout_currency_rate: 62
                    repatriation_commission:
                      amount: 0
                      currency: USD
                    sales_tax:
                      amount: 0
                      currency: USD
                    vat:
                      amount: 0.01
                      currency: USD
                    xsolla_balance_sum:
                      amount: 0
                      currency: USD
                    xsolla_fee:
                      amount: 0
                      currency: USD
                  payment_details:
                    card_holdername: null
                    card_issuer: TEST BANK
                    card_month: 1
                    card_number: 1234123412341234
                    card_scheme: MASTERCARD
                    card_year: 2020
                    customer_firstname: ''
                    customer_lastname: ''
                    enrollment: false
                    ps_account: 1234test4321
                    zip_code: ''
                  subscription_details:
                    is_payment_from_subscription: false
                    is_subscription_created: true
                  transaction_details:
                    amount: 0.04
                    cancellation_date: null
                    country: US
                    currency: USD
                    custom_parameters: null
                    foreign_invoice: null
                    gift_recipient_email: null
                    gift_recipient_id: null
                    payment_date: '2019-03-21 16:15:37'
                    payment_method: '1380'
                    payment_method_name: Credit/Debit Cards
                    project: 21092
                    project_name: Test Project
                    purchase:
                      checkout:
                        amount: 0
                        currency: USD
                      pin_codes:
                        amount: 0
                        content: null
                        currency: null
                      total:
                        amount: 0.03
                        currency: USD
                      virtual_currency:
                        amount: 0.03
                        currency: USD
                        name: Gold coins
                        quantity: '2'
                      virtual_items: null
                    refund_comment: null
                    refund_reason: null
                    status: done
                    user_id: user1
              schema:
                items:
                  properties:
                    customer_details:
                      properties:
                        billing_address:
                          type: string
                        bin:
                          type: string
                        browser_language:
                          type: string
                        country:
                          type: string
                        ip:
                          type: string
                        paystation_country:
                          type: string
                        phone:
                          nullable: true
                          type: string
                        timezone:
                          type: string
                        user_id:
                          type: string
                        user_name:
                          type: string
                      type: object
                    finance_details:
                      properties:
                        direct_wht:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        dispute_fee:
                          properties:
                            amount:
                              description: Die Streitfallgebühr in der Zahlungswährung.
                              format: float
                              type: number
                            currency:
                              description: >-
                                Zahlungswährung. Währungscode, bestehend aus
                                drei Buchstaben gemäß [ISO
                                4217](/de/doc/pay-station/references/supported-currencies/).
                              type: string
                            date:
                              description: Datum der Streitfalleröffnung.
                              type: string
                          type: object
                        payment:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        payment_method_fee:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        payment_method_sum:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        payout:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        payout_currency_rate:
                          format: float
                          type: number
                        repatriation_commission:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        sales_tax:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        vat:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        xsolla_balance_sum:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                        xsolla_fee:
                          properties:
                            amount:
                              format: float
                              type: number
                            currency:
                              type: string
                          type: object
                      type: object
                    payment_details:
                      properties:
                        card_holdername:
                          nullable: true
                          type: string
                        card_issuer:
                          type: string
                        card_month:
                          type: integer
                        card_number:
                          type: integer
                        card_scheme:
                          type: string
                        card_year:
                          type: integer
                        customer_firstname:
                          type: string
                        customer_lastname:
                          type: string
                        enrollment:
                          type: boolean
                        ps_account:
                          type: string
                        zip_code:
                          type: string
                      type: object
                    subscription_details:
                      properties:
                        is_payment_from_subscription:
                          type: boolean
                        is_subscription_created:
                          type: boolean
                      type: object
                    transaction_details:
                      properties:
                        amount:
                          format: float
                          type: number
                        cancellation_date:
                          nullable: true
                          type: string
                        country:
                          type: string
                        currency:
                          type: string
                        custom_parameters:
                          nullable: true
                          type: string
                        foreign_invoice:
                          nullable: true
                          type: string
                        gift_recipient_email:
                          nullable: true
                          type: string
                        gift_recipient_id:
                          nullable: true
                          type: string
                        payment_date:
                          type: string
                        payment_method:
                          type: string
                        payment_method_name:
                          type: string
                        project:
                          type: integer
                        project_name:
                          type: string
                        purchase:
                          properties:
                            checkout:
                              properties:
                                amount:
                                  format: float
                                  type: number
                                currency:
                                  type: string
                              type: object
                            pin_codes:
                              properties:
                                amount:
                                  format: float
                                  type: number
                                content:
                                  nullable: true
                                  type: string
                                currency:
                                  nullable: true
                                  type: string
                              type: object
                            total:
                              properties:
                                amount:
                                  format: float
                                  type: number
                                currency:
                                  type: string
                              type: object
                            virtual_currency:
                              properties:
                                amount:
                                  format: float
                                  type: number
                                currency:
                                  type: string
                                name:
                                  type: string
                                quantity:
                                  type: string
                              type: object
                            virtual_items:
                              nullable: true
                              properties:
                                amount:
                                  format: float
                                  type: number
                                content:
                                  type: string
                                currency:
                                  type: string
                              type: object
                          type: object
                        refund_comment:
                          nullable: true
                          type: string
                        refund_reason:
                          nullable: true
                          type: string
                        status:
                          type: string
                        user_id:
                          type: string
                      type: object
                  type: object
                type: array
          description: Die Transaktionsinformationen wurden erfolgreich zurückgegeben.
      security:
        - basicAuth: []
      summary: Transaktion abrufen
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund:
    put:
      description: >
        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](https://developers.xsolla.com/de/doc/pay-station/features/refund/#pay_station_features_refund_how_it_works_partial_refund_flow).


        <div class="note">

        <p><strong>Hinweis</strong></p><p>Sie können diese API-Methode in der
        Testumgebung aufrufen. Dafür übermitteln Sie die Testzahlung in der
        Anforderung. Lesen Sie die <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-one-time-purchase-in-sandbox/#pay_station_testing_sandbox_bank_card_partial_refund">Anweisung</a>.
        Da finden Sie weitere Informationen über die Testumgebung und die
        Testszenarien.</p>

        </div>


        <p></p>


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: request-partial-refund
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/transaction-id-path-param'
      requestBody:
        content:
          application/json:
            example:
              description: test refund request
              refund_amount: 1.5
            schema:
              properties:
                description:
                  description: Grund für die Erstattung.
                  maxLength: 4000
                  type: string
                refund_amount:
                  description: Erstattungsbetrag in einer Kaufwährung.
                  format: float
                  type: number
              required:
                - description
                - refund_amount
              type: object
        required: true
      responses:
        '204':
          description: Antrag auf Erstattung angenommen
        '403':
          description: Erforderliche Genehmigung fehlt
        '404':
          content:
            application/json:
              example:
                message: Transaction with specified ID does not exist.
              schema:
                properties:
                  message:
                    description: >-
                      Transaktion mit angegebener ID ist nicht vorhanden. Bitte
                      überprüfen Sie die Zahlungsdaten oder kontaktieren Sie den
                      Xsolla-Support unter support@xsolla.com.
                    type: string
                type: object
          description: Transaktion nicht gefunden
        '422':
          content:
            application/json:
              example:
                message: Partial refund is unavailable for subscription payments.
              schema:
                properties:
                  message:
                    description: >
                      **Erstattung ist unzulässig**


                      Gibt eine der folgenden Nachrichten zurück:

                      - Partial refund is unavailable for operations with user
                      balance.

                      - Requested transaction is partial refund and cannot be
                      canceled.

                      - Partial refund is unavailable for subscription payments.

                      - Refund cannot be completed due to a payment system
                      error. Please try again 
                        later.
                      - Requested partial refund amount exceeds payment amount.

                      - Requested partial refund amount is less than minimum
                      amount specified by 
                        payment system.
                      - Payment amount after partial refund will be less than
                      allowable amount 
                        specified by payment system.
                      - Dispute for this invoice is already opened. Can’t make a
                      refund yet.


                      **Die aktuelle Zahlungsmethode unterstützt keine
                      Teilerstattungen**


                      Gibt eine der folgenden Nachrichten zurück:

                      - Current payment method does not support partial refunds.

                      - Current transaction status does not allow refunds.

                      - Deadline for refund is exceeded.

                      - Partial refund is unavailable because discount was
                      applied during payment 
                        creation.

                      **Teilerstattung wegen falscher Genauigkeit nicht
                      möglich**


                      Gibt die folgende Nachricht zurück:

                      - Partial refund is unavailable because requested amount
                      is specified with 
                        incorrect precision for purchase currency.
                    type: string
                type: object
          description: Nicht verarbeitbare Entität
      security:
        - basicAuth: []
      summary: Teilerstattung
      tags:
        - refund
      x-server: true
  /merchants/{merchant_id}/reports/transactions/{transaction_id}/refund:
    put:
      description: >
        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.


        <div class="note">

        <p><strong>Hinweis</strong></p><p>Sie können diese API-Methode in der
        Testumgebung aufrufen. Dafür übermitteln Sie die Testzahlung in der
        Anforderung. Lesen Sie die <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-one-time-purchase-in-sandbox/#pay_station_testing_sandbox_bank_card_refund">Anweisung</a>.
        Da finden Sie weitere Informationen über die Testumgebung und die
        Testszenarien.</p>

        </div>


        <p></p>


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: request-refund
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/transaction-id-path-param'
      requestBody:
        content:
          application/json:
            example:
              description: test refund request
            schema:
              properties:
                description:
                  description: Grund für die Erstattung.
                  maxLength: 4000
                  type: string
                email:
                  description: E-Mail des Benutzers.
                  maxLength: 100
                  type: string
              required:
                - description
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                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.
              schema:
                properties:
                  message:
                    description: >-
                      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.
                    type: string
                type: object
          description: OK (Kein Fehler).
        '204':
          description: Antrag auf Erstattung angenommen.
        '401':
          description: Unauthorized (Zugriff verweigert).
        '404':
          content:
            application/json:
              example:
                message: >-
                  Transaction ID not valid. Please check payment credentials.
                  Otherwise, contact Xsolla support at support@xsolla.com.
              schema:
                properties:
                  message:
                    description: >-
                      Transaktions-ID nicht gültig. Bitte überprüfen Sie die
                      Zahlungsdaten. Andernfalls kontaktieren Sie den
                      Xsolla-Support unter support@xsolla.com.
                    type: string
                type: object
          description: Transaction Not Found.
        '422':
          content:
            application/json:
              example:
                message: >-
                  We are processing the refund request. This may take up to two
                  business days.
              schema:
                properties:
                  message:
                    description: >-
                      Kann eine der folgenden Meldungen anzeigen:

                      - We are processing the refund request. This may take up
                      to two business days.

                      - We are reaching the user for the information required
                      for the refund. For details, contact Xsolla Support.

                      - Incorrect payment status. Refund is possible only for
                      payments with "completed" or "error" status.

                      - To process this request, the customer's email address
                      field must be filled. Please specify the customer's email
                      address and try again.

                      - Full refund is unavailable because there are successful
                      partial refunds for this transaction.

                      - Refund failed. Please contact Xsolla Support to process
                      it manually.

                      - Dispute for this invoice is already opened. Can’t make a
                      refund yet.
                    type: string
                type: object
          description: Unprocessable Entity (Invalid request parameters).
      security:
        - basicAuth: []
      summary: Komplette Erstattung
      tags:
        - refund
      x-server: true
  /merchants/{merchant_id}/reports/transfers:
    get:
      description: >
        Listet alle Auszahlungen für einen Zeitraum auf.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: get-payouts
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
        - $ref: '#/components/parameters/datetime-from'
        - $ref: '#/components/parameters/datetime-to'
        - $ref: '#/components/parameters/legal-entity-id'
        - $ref: '#/components/parameters/payout-status'
      responses:
        '200':
          content:
            application/json:
              example:
                - canceled: 0
                  payout:
                    currency: USD
                    date: '2014-01-03T00:00:00+04:00'
                    id: 1
                    note: 12/05/2013 - 01/04/2014
                  rate: 1
                  transfer:
                    currency: USD
                    date: '2014-01-05T00:00:00+04:00'
                    note: '004357'
          description: OK.
      security:
        - basicAuth: []
      summary: Auszahlungen abrufen
      tags:
        - reports
      x-admin: true
      x-server: true
  /merchants/{merchant_id}/token:
    post:
      description: >
        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 <a
        href="mailto:csm@xsolla.com">csm@xsolla.com</a>. 

        Der neue Wert wird für alle im <a 

        href="https://publisher.xsolla.com/">Kundenportal</a> erstellten
        Projekte Ihrer 

        Firma übernommen.


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>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 <a
        href="https://developers.xsolla.com/de/doc/subscriptions/">Subscriptions</a>-Produkt
        integriert haben.</p><p>Nutzen Sie den folgenden Link, um das
        Zahlungsportal in einem neuen Fenster aufzurufen:
        <code>https://secure.xsolla.com/paystation4/?token={token}</code>, wobei
        <code>{token}</code> der erhaltene Token ist.</p><p>Für Testzwecke steht
        Ihnen die folgende URL zur Verfügung:
        <code>https://sandbox-secure.xsolla.com/paystation4/?token={token}</code>.</p>

        </div>


        <p></p>


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Dieser API-Aufruf enthält nicht den
        Pfadparameter <code>project_id</code>, Sie müssen also den API-Schlüssel
        verwenden, der in allen Projekten des Unternehmens gültig ist, um die
        Autorisierung einzurichten.</p>

        </div>
      operationId: create-token
      parameters:
        - $ref: '#/components/parameters/merchant-id-path-param'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/token'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                token: eop57k1boA7nnYPtewZ6KEXJyJADEwRT
              schema:
                properties:
                  token:
                    type: string
                type: object
          description: Created.
        '422':
          content:
            application/json:
              example:
                extended_message:
                  global_errors: []
                  property_errors:
                    purchase.checkout.amount:
                      - String value found, but a number is required
                http_status_code: 422
                message: >-
                  JSON is not valid against json schema, please check
                  documentation
                  https://developers.xsolla.com/de/api/v2/getting-started/#api_token_ui
                request_id: cd72633
              schema:
                properties:
                  extended_message:
                    properties:
                      global_errors:
                        items:
                          type: string
                        type: array
                      property_errors:
                        description: >-
                          Objekt enthält Parameternamen mit
                          Fehlerbeschreibungen.
                        type: object
                    type: object
                  http_status_code:
                    type: integer
                  message:
                    type: string
                  request_id:
                    type: string
                type: object
          description: Unprocessable Entity.
      security:
        - basicAuth: []
      summary: Token erstellen
      tags:
        - token
      x-server: true
  /projects/{project_id}/users/{user_id}/payment_accounts:
    get:
      description: >
        Listet die gespeicherten Zahlungskonten eines festgelegten Benutzers
        auf.


        <div class="note">

        <p><strong>Hinweis</strong></p><p>In der Testumgebung funktioniert
        dieser API-Aufruf nur mit <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-cards/">Testkarten</a>
        ohne "3-D Secure"-Funktion.</p>

        </div>
      operationId: get-saved-accounts
      parameters:
        - $ref: '#/components/parameters/project-id-path-param'
        - $ref: '#/components/parameters/user-id-path-param'
        - $ref: '#/components/parameters/mode'
      responses:
        '200':
          content:
            application/json:
              example:
                - id: 4612345
                  name: PP_saved_account
                  payment_system:
                    id: 24
                    name: PayPal
                  type: paypal
          description: OK.
      security:
        - basicAuth: []
      summary: Gespeicherte Konten abrufen
      tags:
        - tokenization
      x-server: true
  /projects/{project_id}/users/{user_id}/payment_accounts/{type}/{account_id}:
    delete:
      description: >
        Löscht ein gespeichertes Zahlungskonto.


        <div class="note">

        <p><strong>Hinweis</strong></p><p>In der Testumgebung funktioniert
        dieser API-Aufruf nur mit <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-cards/">Testkarten</a>
        ohne "3-D Secure"-Funktion.</p>

        </div>


        <p></p>


        <div class="note">

        <p><strong>Hinweis</strong></p><p>Sie können diese API-Methode in der
        Testumgebung aufrufen. Dafür übermitteln Sie die Testzahlung in der
        Anforderung. Lesen Sie die <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-saved-cards-in-sandbox/#pay_station_testing_tokenization_sandbox_delete_saved_card">Anweisung</a>.
        Da finden Sie weitere Informationen über die Testumgebung und die
        Testszenarien.</p>

        </div>
      operationId: delete-saved-account
      parameters:
        - $ref: '#/components/parameters/project-id-path-param'
        - $ref: '#/components/parameters/user-id-path-param'
        - $ref: '#/components/parameters/type-path-param'
        - $ref: '#/components/parameters/account-id-path-param'
      responses:
        '204':
          description: No Content.
      security:
        - basicAuth: []
      summary: Gespeichertes Zahlungskonto löschen
      tags:
        - tokenization
      x-server: true
  /projects/{project_id}/users/{user_id}/payments/{type}/{account_id}:
    post:
      description: >
        Von einem gespeicherten Zahlungskonto des Benutzers abbuchen.


        <div class="note">

        <p><strong>Hinweis</strong></p><p>In der Testumgebung funktioniert
        dieser API-Aufruf nur mit <a
        href="https://developers.xsolla.com/de/doc/pay-station/testing/test-cards/">Testkarten</a>
        ohne "3-D Secure"-Funktion.</p>

        </div>


        <p></p>


        <div class="notice">

        <p><strong>Hinweis</strong></p><p>Damit der API-Aufurf korrekt
        funktioniert, müssen Sie einen Timeout von 2 Minuten konfigurieren.</p>

        </div>
      operationId: charge-with-saved-account
      parameters:
        - $ref: '#/components/parameters/project-id-path-param'
        - $ref: '#/components/parameters/user-id-path-param'
        - $ref: '#/components/parameters/type-path-param'
        - $ref: '#/components/parameters/account-id-path-param'
      requestBody:
        $ref: '#/components/requestBodies/charge-with-saved-account'
      responses:
        '201':
          content:
            application/json:
              example:
                transaction_id: 123458390
              schema:
                properties:
                  transaction_id:
                    type: integer
                type: object
          description: Created.
        '422':
          description: Unprocessable Entity.
      security:
        - basicAuth: []
      summary: Von gespeichertem Konto abbuchen
      tags:
        - tokenization
      x-server: true
components:
  securitySchemes:
    basicAuth:
      description: >-
        Die Xsolla-API verwendet die Basisauthentifizierung. Alle Anfragen an
        die API müssen den Header `Authorization: Basic
        <your_authorization_basic_key>` enthalten, wobei
        `<your_authorization_basic_key>` das `merchant_id:api_key`-Paar ist, das
        gemäß dem Base64-Standard kodiert ist.

         Diese Parameter finden Sie im [Kundenportal](https://publisher.xsolla.com/):<ul><li>Die `merchant_id` finden Sie:<ul><li>unter unter **Firmeneinstellungen > Firma**;</li><li>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/<merchant_id>`.</li></ul></li><li>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:<ul><li>**Firmeneinstellungen > API-Schlüssel**</li><li>**Projekteinstellungen > API-Schlüssel**</li></ul></li></ul><br>
        Weitere Informationen über die Arbeit mit API-Schlüsseln finden Sie in
        der
        [API-Referenz](https://developers.xsolla.com/de/api/getting-started/#api_keys_overview).
      scheme: basic
      type: http
  parameters:
    merchant-id-path-param:
      description: Händler-ID.
      in: path
      name: merchant_id
      required: true
      schema:
        type: integer
    project-id-path-param:
      description: Projekt-ID.
      in: path
      name: project_id
      required: true
      schema:
        type: integer
    transaction-id-path-param:
      description: Transaktions-ID.
      in: path
      name: transaction_id
      required: true
      schema:
        type: integer
    datetime-from-req:
      description: >-
        Beginn des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn
        mindestens einer der folgenden Parameter übermittelt
        wird:<ul><li>`transfer_id`</li><li>`report_id`</li></ul>
      example: '2023-02-08'
      in: query
      name: datetime_from
      required: true
      schema:
        format: datetime
        type: string
    datetime-to-req:
      description: "Ende des Zeitraums im Format JJJJ-MM-TT. Nicht erforderlich, wenn mindestens einer der folgenden Parameter übermittelt wird:<ul><li>`transfer_id`</li><li>`report_id`</li></ul> Der Zeitraum zwischen `datetime_from` und `datetime_to` darf maximal 92\_Tage betragen."
      example: '2023-03-08'
      in: query
      name: datetime_to
      required: true
      schema:
        format: datetime
        type: string
    format:
      description: Datenformat.
      in: path
      name: format
      required: true
      schema:
        enum:
          - json
          - csv
          - xls
        type: string
    in-transfer-currency:
      description: >-
        Konvertiert alle Finanzdaten in die Auszahlungswährung (standardmäßig
        wird die Einzahlungswährung verwendet). Nicht erforderlich, wenn
        mindestens einer der folgenden Parameter übermittelt
        wird:<ul><li>`transfer_id`</li><li>`report_id`</li></ul>
      in: query
      name: in_transfer_currency
      required: true
      schema:
        type: integer
    show-total:
      description: >-
        Ob der Gesamtbetrag der Transaktionen im Bericht enthalten sein soll.
        Nur für den Export im CSV-Format verfügbar. Standardwert ist `true`.
      in: query
      name: show_total
      schema:
        type: boolean
    merchant-of-records:
      description: >-
        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.
      in: query
      name: merchant_of_records
      required: false
      schema:
        enum:
          - xsolla
          - merchant
        nullable: true
        type: string
        x-enumDescriptions:
          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-id-query-param:
      description: Projekt-ID.
      in: query
      name: project_id
      required: false
      schema:
        type: integer
    show-dry-run:
      description: >-
        Legt fest, ob testweise durchgeführte Transaktionen miteinbezogen
        werden.
      in: query
      name: show_dry_run
      required: false
      schema:
        type: boolean
    transfer-id:
      description: ID der Auszahlung.
      in: query
      name: transfer_id
      required: false
      schema:
        type: integer
    report-id:
      description: ID des Finanzberichts.
      in: query
      name: report_id
      required: false
      schema:
        type: integer
    offset:
      description: >-
        Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei
        0).
      in: query
      name: offset
      required: false
      schema:
        type: integer
    limit-req:
      description: >-
        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.
      in: query
      name: limit
      required: false
      schema:
        type: integer
    transaction-status:
      description: Status der Transaktion.
      in: query
      name: status
      required: false
      schema:
        enum:
          - done
          - canceled
          - error
          - refunded
        type: string
    datetime-from:
      description: Beginn des Zeitraums.
      in: query
      name: datetime_from
      required: false
      schema:
        format: datetime
        type: string
    datetime-to:
      description: Ende des Zeitraums.
      in: query
      name: datetime_to
      required: false
      schema:
        format: datetime
        type: string
    transaction-id:
      description: Transaktions-ID.
      in: query
      name: transaction_id
      required: false
      schema:
        type: integer
    type:
      description: 'In den Suchergebnissen angezeigte Transaktionsart:'
      in: query
      name: type
      required: false
      schema:
        enum:
          - all
          - transferred
          - canceled
          - test
        type: string
        x-enumDescriptions:
          all: Alle Transaktionen.
          canceled: Stornierte Transaktionen ohne Testtransaktionen.
          test: Testtransaktionen.
          transferred: Erfolgreiche Transaktionen ohne Testtransaktionen.
    phone:
      description: Telefonnummer des Benutzers (im internationalen Format).
      in: query
      name: phone
      required: false
      schema:
        type: string
    user-id-query-param:
      description: >-
        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](/de/doc/pay-station/references/faq/#faq_validation).
      in: query
      name: user_id
      required: false
      schema:
        type: string
    user-name:
      description: Benutzername.
      in: query
      name: user_name
      required: false
      schema:
        type: string
    user-custom:
      description: Benutzerdefinierte Parameter zur Benutzeridentifikation.
      in: query
      name: user_custom
      required: false
      schema:
        type: string
    email:
      description: E-Mail des Benutzers.
      in: query
      name: email
      required: false
      schema:
        maxLength: 100
        type: string
    external-id:
      description: >-
        Transaktions-ID im Spiel. Eine individuelle ID pro Benutzerzahlung
        erforderlich.
      in: query
      name: external_id
      required: false
      schema:
        type: string
    order-id:
      description: >-
        Bestell-ID. Sie dient zum Aufruf der API-Methode [Bestellung
        abrufen](/de/api/shop-builder/operation/get-order/).
      example: 1234
      in: query
      name: order_id
      required: false
      schema:
        type: integer
    limit:
      description: Begrenzung der Elementanzahl auf der Seite.
      in: query
      name: limit
      required: false
      schema:
        type: integer
    status:
      description: Ein Transaktionsstatus.
      in: query
      name: status
      required: false
      schema:
        $ref: '#/components/schemas/status.enum'
    legal-entity-id:
      description: ID des Rechtssubjekts, das zum Entwickler gehört.
      in: query
      name: legal_entity_id
      required: false
      schema:
        type: integer
    payout-status:
      description: Auszahlungsstatus.
      in: query
      name: status
      required: false
      schema:
        enum:
          - hold
          - ready
          - paid
        type: string
        x-enumDescriptions:
          hold: Warten auf eine Anfrage, um fortfahren zu dürfen
          paid: Auszahlung abgeschlossen.
          ready: Auszahlung läuft.
    user-id-path-param:
      description: >-
        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](/de/doc/pay-station/references/faq/#faq_validation).
      in: path
      name: user_id
      required: true
      schema:
        type: string
    mode:
      description: >-
        Legen Sie als Wert `sandbox` fest, um den Zahlungsvorgang zu testen.
        Entfernen Sie den Parameter um tatsächliche Zahlungen zu tätigen.
      in: query
      name: mode
      required: false
      schema:
        type: string
    type-path-param:
      description: Zahlungskontotyp.
      in: path
      name: type
      required: true
      schema:
        enum:
          - card
          - amazon
          - skrill
          - paypal
          - toss
          - alipayplus_cn
          - alipayplus_hk
          - alipayplus_gcash
          - alipayplus_dana
          - alipayplus_rabbitlinepay
          - alipayplus_tng
          - alipayplus_boost
          - alipayplus_truemoney
          - alipayplus_maya
          - alipayplus_kplus
          - softbank_paypay
          - softbank_docomo
          - softbank_softbank2
          - softbank_au
          - softbank_ymobile
          - paysafecard_eu
          - paysafecard_us
          - paidy
          - klarna
          - mercadopago
          - nupay
        type: string
        x-enumDescriptions:
          alipayplus_boost: Boost.
          alipayplus_cn: Alipay.
          alipayplus_dana: DANA.
          alipayplus_gcash: GCash.
          alipayplus_hk: Alipay (Hongkong).
          alipayplus_kplus: K PLUS.
          alipayplus_maya: Maya.
          alipayplus_rabbitlinepay: Rabbit LINE pay.
          alipayplus_tng: Touch 'n Go.
          alipayplus_truemoney: TrueMoney Wallet.
          amazon: Amazon Pay.
          card: Bankkarten.
          klarna: >-
            Klarna. Das Speichern der Kontodaten ist nur in den USA, im
            Vereinigten Königreich, in Schweden, in Deutschland, in Österreich,
            in Norwegen, in Finnland, in Dänemark und in den Niederlanden
            möglich.
          mercadopago: Mercado Pago (einschließlich Mercado Pago Connect).
          nupay: NuPay.
          paidy: Paidy.
          paypal: PayPal.
          paysafecard_eu: Paysafecard (EU).
          paysafecard_us: Paysafecard (USA).
          skrill: Skrill Digital Wallet.
          softbank_au: au Easy Payment.
          softbank_docomo: Docomo.
          softbank_paypay: PayPay.
          softbank_softbank2: SoftBank.
          softbank_ymobile: Y!mobile.
          toss: Toss Wallet.
    account-id-path-param:
      description: ID des gespeicherten Kontos in der Xsolla-Datenbank.
      in: path
      name: account_id
      required: true
      schema:
        type: integer
  schemas:
    empty-body:
      description: >-
        Damit der API-Aufruf korrekt funktioniert, muss der Anfragerumpf leer
        sein.
      nullable: true
      type: object
    status.enum:
      enum:
        - created
        - processing
        - review
        - error
        - done
        - awaitingRefund
        - refunded
        - canceled
        - partiallyRefunded
      type: string
      x-enumDescriptions:
        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.
    custom_parameters:
      description: >-
        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](mailto:csm@xsolla.com).
      properties:
        active_date:
          description: >-
            Letztmalig online; Datum gemäß [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601).
          type: string
        additional_verification:
          description: >-
            Filtert danach, ob der Spieler Konto-Verifikationsverfahren
            verwendet.
          type: boolean
        character_customized:
          description: >-
            Filtert danach, ob der Spieler seinen Charakter individuell
            angepasst hat.
          type: boolean
        chat_activity:
          description: Filtert danach, ob der Spieler die Chatfunktion verwendet.
          type: boolean
        completed_tasks:
          description: Anzahl der erledigten Aufgaben bzw. erreichten Ziele.
          type: integer
        forum_activity:
          description: Filtert danach, ob der Spieler die Chatfunktion verwendet.
          type: boolean
        items_used:
          description: >-
            Filtert danach, ob der Spieler im Spiel gekaufte Gegenstände
            verwendet.
          type: boolean
        karma_points:
          description: Karma des Spielers.
          type: integer
        last_change_password_date:
          description: >-
            Datum der letzten Kennwortänderung; Datumsangabe gemäß [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601).
          type: string
        non_premium_currency:
          description: Betrag der gewöhnlichen ("non-premium") Währung.
          format: float
          type: number
        notifications_enabled:
          description: >-
            Filtert danach, ob der Spieler den Erhalt von Benachrichtigungen
            aktiviert hat.
          type: boolean
        profile_completed:
          description: >-
            Filtert danach, ob der Spieler auf seinem Profil zusätzliche
            Informationen hinzugefügt hat.
          type: boolean
        profile_image_added:
          description: Filtert danach, ob der Spieler ein Profilbild hochgeladen hat.
          type: boolean
        pvp_activity:
          description: Ob der Spieler an PvP-Schlachten (Player versus Player) teilnimmt.
          type: boolean
        registration_date:
          description: >-
            Datum der Kontoerstellung gemäß [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601).
          type: string
        session_time:
          description: >-
            Durchschnittliche Sitzungsdauer, Angabe gemäß [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601).
          type: string
        social_networks_added:
          description: >-
            Filtert danach, ob der Spieler Profile von sozialen Netzwerken
            verknüpft hat.
          type: boolean
        total_bans:
          description: Filtert danach, wie oft der Spieler im Chat/Forum gesperrt wurde.
          type: integer
        total_characters:
          description: Anzahl der Charaktere im Spiel.
          type: integer
        total_clans:
          description: Anzahl der Clans, bei denen der Spieler Mitglied ist.
          type: integer
        total_friends:
          description: Anzahl der Freunde.
          type: integer
        total_game_events:
          description: Anzahl der Ingame-Events, an denen der Spieler teilgenommen hat.
          type: integer
        total_gifts:
          description: >-
            Anzahl der Geschenke im Spiel, die der Spieler verschickt/erhalten
            hat.
          type: integer
        total_hours:
          description: Gesamtzahl der Spielstunden.
          type: integer
        total_inventory_value:
          description: Gesamtwert des Inventars (in Ingame-Währung).
          format: float
          type: number
        total_sum:
          description: Gesamtbetrag der Zahlungen.
          format: float
          type: number
        tutorial_completed:
          description: >-
            Filtert danach, ob der Spieler das Tutorial des Spiels absolviert
            hat.
          type: boolean
        unlocked_achievements:
          description: Anzahl an freigeschalteten Errungenschaften.
          type: integer
        user_level:
          description: Level, Ansehen oder Rang des Spielers.
          type: integer
        win_rate:
          description: Gewinnquote.
          type: integer
      type: object
    subscription:
      description: Daten zum Abonnement (Objekt).
      properties:
        available_plans:
          description: >-
            Abonnement-Modelle (Array), die im Zahlungsportal angezeigt werden
            sollen.
          items:
            type: string
          type: array
        currency:
          description: >-
            Währung des Abo-Modells, die bei allen Kalkulationen verwendet
            werden soll.
          type: string
        operation:
          description: >-
            Diese Operationsart kommt beim Abo-Modell des Nutzers zur Anwendung.
            Zur Änderung des Abo-Modells muss der `change_plan`-Wert übermittelt
            werden. Sie müssen die ID des neuen Abo-Modells im
            `purchase.subscription.plan_id`-Parameter festlegen.
          type: string
        plan_id:
          description: >-
            Externe ID des Abo-Modells. Diese finden Sie im Kundenportal unter
            **Subscriptions > Abo-Modelle**.
          type: string
        product_id:
          description: Produkt-ID.
          type: string
        trial_days:
          description: Probezeitraum in Tagen.
          type: integer
      type: object
    purchase:
      description: Objekt, welches Angaben zum Kauf enthält.
      properties:
        subscription:
          $ref: '#/components/schemas/subscription'
      type: object
    currency:
      description: >-
        Bevorzugte Zahlungswährung. Währungscode, bestehend aus drei Buchstaben
        gemäß [ISO
        4217](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/).
      type: string
    external_id:
      description: >-
        Transaktions-ID im Spiel. Muss für jede Benutzerzahlung eindeutig sein.
        Detaillierte Informationen dazu finden Sie in der <a
        href="https://developers.xsolla.com/de/doc/pay-station/references/faq/#faq_payments_q_new_transaction_external_id">Dokumentation</a>.
      type: string
    language:
      description: >-
        Sprache der Benutzeroberfläche.
        [Sprachencode](https://developers.xsolla.com/de/doc/pay-station/features/localization/),
        bestehend aus 2 Kleinbuchstaben.
      type: string
    mode.settings:
      description: >-
        Legen Sie als Wert `sandbox` fest, um den Zahlungsvorgang auszutesten.
        Für einen solchen Fall nutzen Sie *https://sandbox-secure.xsolla.com*,
        um das Zahlungsportal auszutesten.
      type: string
    payment_method:
      description: ID der Zahlungsart.
      type: integer
    payment_widget:
      description: >-
        Zahlungs-Widget. Kann `paybycash` oder `giftcard` sein. Wenn der
        Parameter festgelegt ist, wird der Benutzer entsprechend zum Widget "Pay
        by Cash" oder zum Widget "Gift Cards" weitergeleitet.
      enum:
        - paybycash
        - giftcard
      type: string
    project_id:
      description: Xsolla-ID des Spiels. Kann im Kundenportal eingesehen werden.
      type: integer
    redirect_policy:
      description: Weiterleitungsrichtlinien-Einstellungen (Objekt).
      properties:
        delay:
          description: >-
            Verzögerung (in Sekunden), nach der ein Benutzer automatisch zur
            Rückgabe-URL weitergeleitet wird.
          type: integer
        manual_redirection_action:
          description: >-
            Das Verhalten der Pay Station wird ausgelöst, wenn der Benutzer auf
            die Schaltfläche Schließen oder die Schaltfläche **Zurück zum
            Spiel** klickt. Kann `redirect` (standardmäßig) und `postmessage`
            sein. Wenn auf `redirect` gesetzt, wird ein Benutzer zu der im Token
            übergebenen oder im Kundenportal angegebenen URL umgeleitet. Wenn er
            auf `postmessage` gesetzt ist, wird ein Benutzer nicht auf andere
            Seiten umgeleitet. Durch Klicken auf das Schließen-Symbol wird das
            `close` Ereignis gesendet, und durch Klicken auf die Schaltfläche
            **Zurück zum Spiel** - das `return` Ereignis.
          enum:
            - redirect
            - postmessage
          type: string
        redirect_button_caption:
          description: Text auf der Schaltfläche für die manuelle Weiterleitung.
          type: string
        redirect_conditions:
          description: >-
            Zahlungsstatus, bei dem ein Benutzer zur Rückgabe-URL weitergeleitet
            wird. Möglich sind: `none`, `successful`, `successful_or_canсeled`
            oder `any`.
          enum:
            - none
            - successful
            - successful_or_canceled
            - any
          type: string
        status_for_manual_redirection:
          description: >-
            Zahlungsstatus, bei dem eine Schaltfläche angezeigt wird, die einen
            Benutzer zur Rückgabe-URL weiterleitet. Möglich sind: `none`,
            `successful`, `successful_or_canсeled` oder `any`.
          enum:
            - none
            - successful
            - successful_or_canceled
            - any
          type: string
      type: object
    return_url:
      description: >-
        URL der Seite, zu der ein Benutzer nach dem Bezahlen weitergeleitet
        wird. Wie Sie Weiterleitungen konfigurieren, erfahren Sie in der <a
        href="https://developers.xsolla.com/de/doc/pay-station/how-to/how-to-configure-redirects/">Dokumentation</a>.
      type: string
    ap_quick_payment_button:
      description: "Ob die Schaltfläche für die Sofortzahlung per Apple\_Pay oben im Zahlungsportal \nauf unterstützten Geräten angezeigt werden soll. Standartwert: `true`. Ist \n`false` festgelegt, wird Apple\_Pay gemäß dem [PayRank](/de/doc/pay-station/how-to/how-to-manage-top-payment-methods/)-Algorithmus in der Liste der \nZahlungsmethoden angezeigt.\n\n<div class=\"note\">\n<p><strong>Hinweis</strong></p><p>Auf Android- und allen anderen Geräten, auf denen eine Zahlung per Apple\_Pay nicht möglich ist, ist diese Zahlungsmethode unabhängig vom Parameterwert in der Liste der verfügbaren Zahlungsmethoden ausgeblendet.</p>\n</div>\n"
      type: boolean
    components:
      description: Menü-Einstellungen (Objekt).
      properties:
        subscriptions:
          description: Untermenü "Abo-Modelle" (Objekt).
          properties:
            hidden:
              description: Legt fest, ob das Untermenü angezeigt wird.
              type: boolean
            order:
              description: Position des Untermenüs im Hauptmenü.
              type: integer
          type: object
        virtual_currency:
          description: Untermenü "Virtuelle Währung".
          properties:
            custom_amount:
              description: >-
                Legt fest, ob der Benutzer eine willkürliche Menge der
                virtuellen Währung im Zahlungsportal eingeben kann.
              type: boolean
            hidden:
              description: Legt fest, ob das Untermenü angezeigt wird.
              type: boolean
            order:
              description: Position des Untermenüs im Hauptmenü.
              type: integer
          type: object
        virtual_items:
          description: Untermenü "Virtuelle Gegenstände".
          properties:
            hidden:
              description: Legt fest, ob das Untermenü angezeigt wird.
              type: boolean
            order:
              description: Position des Untermenüs im Hauptmenü.
              type: integer
            selected_group:
              description: >-
                Gruppe, die nach dem Öffnen der Registerkarte "Virtuelle
                Gegenstände" angezeigt wird.
              type: string
            selected_item:
              description: >-
                Gegenstand, der nach dem Öffnen der Registerkarte "Virtuelle
                Gegenstände" angezeigt wird (SKU des Gegenstands).
              type: string
          type: object
      type: object
    currency_format:
      description: >-
        Damit ein Währungscode bestehend aus drei Buchstaben gemäß [ISO
        4217](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)
        im Zahlungsportal angezeigt wird, müssen Sie `code` als Wert festlegen.
        Standardmäßig wird das Währungssymbol anstelle des Währungscodes
        angezeigt.
      type: string
    close_button_icon:
      description: Das Symbol der **Schließen**-Schaltfläche im Zahlungsportal.
      enum:
        - arrow
        - cross
      type: string
      x-enumDescriptions:
        arrow: >-
          Das Symbol **←** an der linken Seite der Kopfzeile des
          Zahlungsportals.
        cross: >-
          Das Symbol **×** an der rechten Seite der Kopfzeile des
          Zahlungsportals.
    header.desktop:
      description: Einstellungen für den Header (Objekt).
      properties:
        close_button:
          description: >-
            Ob eine **Schließen**-Schaltfläche im Zahlungsportal angezeigt wird.
            Die Schaltfläche schließt das Zahlungsportal und leitet den Benutzer
            an die im `settings.return_url`-Parameter angegebene URL weiter.
            Standardmäßig ist `false` voreingestellt.
          type: boolean
        close_button_icon:
          $ref: '#/components/schemas/close_button_icon'
        is_visible:
          description: Legt fest, ob der Header im Zahlungsportal angezeigt wird.
          type: boolean
        type:
          description: >-
            Erscheinungsbild des Headers. Als Wert lässt sich entweder `compact`
            (Projektname und Benutzer-ID sind ausgeblendet) oder `normal`
            (voreingestellt) festlegen.
          enum:
            - compact
            - normal
          type: string
        visible_logo:
          description: >-
            Ist `true` festgelegt, wird das Logo im Header angezeigt. Öffnen Sie
            Ihr Projekt im [Kundenportal](https://publisher.xsolla.com/), und
            navigieren Sie zu **Pay Station > Einstellungen**, um das Bild
            hochzuladen.
          type: boolean
        visible_name:
          description: Legt fest, ob der Projektname im Header angezeigt wird.
          type: boolean
        visible_purchase:
          description: >-
            Legt fest, ob die Kaufbeschreibung (`purchase.description.value`) im
            Header angezeigt wird. `true` ist voreingestellt.
          type: boolean
      type: object
    subscription_list.desktop:
      description: Einstellungen zur Liste der Abo-Modelle (Objekt).
      properties:
        description:
          description: >-
            Jeglicher Text, der im Zahlungsportal oberhalb der Liste der
            verfügbaren Abo-Modelle angezeigt werden soll.
          type: string
        display_local_price:
          description: >-
            Falls als Wert `true` festgelegt ist und falls die Landeswährung des
            Benutzers sich von der für das Abo-Modell festgelegten Währung
            unterscheidet, werden dem Benutzer beide Preise angezeigt: Einer in
            der Landes- und der andere in der Basiswährung.
          type: boolean
      type: object
    desktop.ui:
      description: Schnittstellen-Einstellungen für die Desktop-Version (Objekt).
      properties:
        header:
          $ref: '#/components/schemas/header.desktop'
        subscription_list:
          $ref: '#/components/schemas/subscription_list.desktop'
      type: object
    gp_quick_payment_button:
      description: "Die Art und Weise, wie die Zahlungsmethode Google\_Pay angezeigt wird. Ist `true` festgelegt, wird die Schaltfläche für die Schnellzahlung per Google\_Pay unabhängig vom Gerät und Browser des Nutzers oben im Zahlungsportal angezeigt. Ist `false` festgelegt, wird Google\_Pay gemäß dem [PayRank](/de/doc/pay-station/how-to/how-to-manage-top-payment-methods/)-Algorithmus in der Liste der Zahlungsmethoden angezeigt. Wird der Parameter nicht übermittelt, wird Google\_Pay oben im Zahlungsportal auf allen Geräten und Browsern angezeigt, außer in Safari\_– in Safari wird Google\_Pay in der Liste der Zahlungsmethoden angezeigt."
      type: boolean
    header.ui:
      properties:
        visible_virtual_currency_balance:
          description: >-
            Legt fest, ob dieses Element im Zahlungsportal ausgeblendet werden
            kann. `true` voreingestellt.
          type: boolean
      type: object
    is_cart_open_by_default:
      description: >-
        Wie die Liste der Warenkorbartikel und die Finanzdaten im Zahlungsportal
        angezeigt werden. Ist `true` festgelegt, werden die Informationen in
        einer ausgeklappten Ansicht dargestellt. Wenn `false`(Standard)
        festgelegt ist oder der Parameter nicht übermittelt wird, werden die
        Informationen in einer zusammengeklappten Ansicht dargestellt.
      type: boolean
    is_independent_windows:
      description: >-
        Ob die Benutzer beim Kauf vom im Startprogramm eingebetteten Browser
        (WebView) zu ihrem Standardbrowser weitergeleitet werden sollen. `false`
        ist voreingestellt.
      type: boolean
    is_language_selector_hidden:
      description: >-
        Ob die Sprachauswahl auf der Zahlungsseite ausgeblendet ist. Ist `false`
        festgelegt (Standard), wird die Sprachauswahl angezeigt.
      type: boolean
    is_payment_methods_list_mode:
      description: >-
        Ob die Liste der im Land des Benutzers verfügbaren Zahlungsmethoden beim
        Öffnen des Zahlungsportals angezeigt wird. Ist `false` festgelegt
        (Standard), wird die im Parameter `settings.payment_method` übermittelte
        Zahlungsmethode oder die vom
        [PayRank-Algorithmus](https://developers.xsolla.com/de/solutions/payments/payment-ui-management/top-payment-methods-management/)
        ausgewählte Zahlungsmethode angezeigt.
      type: boolean
    is_prevent_external_link_open:
      description: >-
        Ob die Umleitung von Links auf eine externe Ressource deaktiviert ist
        oder nicht. `false` standardmäßig. Wenn Sie auf einen externen Link
        klicken, wird das `external-link-open` Ereignis über den `postMessage`
        Mechanismus gesendet. Die Adresse für den umgeleiteten Link wird im
        `url` Parameter übergeben.
      type: boolean
    is_search_field_hidden:
      description: >-
        Ob im Zahlungsportal eine Suchleiste für Zahlungsmethoden angezeigt
        wird. Ist `true` festgelegt, ist die Suchleiste ausgeblendet.
        Standardmäßig ist `false` festgelegt.
      type: boolean
    is_show_close_widget_warning:
      description: >-
        Legt fest, ob eine Warnung über die Verarbeitung der Transaktion
        angezeigt werden soll, wenn der Mauszeiger über das Symbol **×** bewegt
        wird, bevor die Zahlungsseite geschlossen wird. Wenn `false` übermittelt
        wird, oder der Parameter nicht übermittelt wird, wird die Warnung nicht
        angezeigt. Es ist standardmäßig auf `true` gestellt.
      type: boolean
    is_three_ds_independent_windows:
      default: false
      description: >-
        Ob die "3-D Secure"-Prüfung in einem neuen Browserfenster geöffnet wird.
        Legen Sie `true` fest, wenn Ihr Setup eine Content Security Policy (CSP)
        vorschreibt.
      type: boolean
    layout:
      description: >-
        Position der Hauptelemente des Zahlungsportals. Sie können das
        Zahlungsportal im Spiel öffnen und/oder die Spalte mit den
        Bestellinformationen und den Angaben zu den Zahlungsmethoden
        vertauschen. Ausführliche Informationen finden Sie in den
        [Anpassungsanweisungen](https://developers.xsolla.com/de/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout).
      enum:
        - embed
        - column_reverse
        - embed_column_reverse
      type: string
    mobile.ui:
      properties:
        header:
          properties:
            close_button:
              description: >-
                Legt fest, ob eine **Schließen**-Schaltfläche in der
                Mobil-Version der Pay Station angezeigt wird. Die Schaltfläche
                schließt die Pay Station und leitet den Benutzer an die im
                `settings.return_url`-Parameter angegebene URL weiter.
                Standardmäßig ist `false` voreingestellt.
              type: boolean
            close_button_icon:
              $ref: '#/components/schemas/close_button_icon'
          type: object
      type: object
    mode.ui:
      description: >
        Anzeigemodus des Zahlungsportals zur Verwaltung gespeicherter
        Zahlungsmethoden. 

        Kann auf `user_account` gesetzt oder weggelassen werden. In diesem Modus
        kann 

        der Nutzer nur die Sprache ändern, neue Zahlungsmethoden hinzufügen und 

        bestehende entfernen.


        <div class="note">

        <p><strong>Hinweis</strong></p><p>Wenn dieser Parameter übermittelt
        wird, wird der Weiterleitungs-Button nicht angezeigt. Um einen Nutzer
        nach dem Speichern der Zahlungsmethode weiterzuleiten, müssen Sie die <a
        href="/de/doc/pay-station/how-to/how-to-configure-redirects/#pay_station_how_to_configure_redirects_automatic/">automatischen
        Weiterleitungen</a> konfigurieren.</p>

        </div>
      type: string
    theme.ui:
      description: "Zahlungsportal-Theme. Möglich sind \"63295a9a2e47fab76f7708e1\" (helles Theme\_– voreingestellt) oder \"63295aab2e47fab76f7708e3\" (dunkles Theme). Sie können außerdem ein [individuelles Theme erstellen](https://developers.xsolla.com/de/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token) und dessen ID im Parameter übermitteln."
      enum:
        - 63295a9a2e47fab76f7708e1
        - 63295aab2e47fab76f7708e3
      type: string
    payment_accounts_enable:
      properties:
        enable:
          description: >-
            Legt fest, ob das Stiftsymbol, das zur Bearbeitungsseite für
            Zahlungsmethoden weiterleitet, im Zahlungsportal angezeigt werden
            soll. Standardmäßig ist `true` festgelegt.
          type: boolean
        order:
          description: >-
            Position des Abschnitts in der Drop-down-Liste im Zahlungsportal.
            Erforderlich, wenn
            `settings.ui.user_account.payment_accounts.enable` übermittelt wird.
          minimum: 1
          type: integer
      type: object
    user_account:
      description: Details zum Benutzerkonto (Objekt).
      properties:
        payment_accounts:
          allOf:
            - description: Abschnitt **Gespeicherte Methoden**.
            - $ref: '#/components/schemas/payment_accounts_enable'
      type: object
    ui:
      description: Schnittstellen-Einstellungen (Objekt).
      properties:
        apple_pay_quick_payment_button:
          $ref: '#/components/schemas/ap_quick_payment_button'
        components:
          $ref: '#/components/schemas/components'
        currency_format:
          $ref: '#/components/schemas/currency_format'
        desktop:
          $ref: '#/components/schemas/desktop.ui'
        gp_quick_payment_button:
          $ref: '#/components/schemas/gp_quick_payment_button'
        header:
          $ref: '#/components/schemas/header.ui'
        is_cart_open_by_default:
          $ref: '#/components/schemas/is_cart_open_by_default'
        is_independent_windows:
          $ref: '#/components/schemas/is_independent_windows'
        is_language_selector_hidden:
          $ref: '#/components/schemas/is_language_selector_hidden'
        is_payment_methods_list_mode:
          $ref: '#/components/schemas/is_payment_methods_list_mode'
        is_prevent_external_link_open:
          $ref: '#/components/schemas/is_prevent_external_link_open'
        is_search_field_hidden:
          $ref: '#/components/schemas/is_search_field_hidden'
        is_show_close_widget_warning:
          $ref: '#/components/schemas/is_show_close_widget_warning'
        is_three_ds_independent_windows:
          $ref: '#/components/schemas/is_three_ds_independent_windows'
        layout:
          $ref: '#/components/schemas/layout'
        mobile:
          $ref: '#/components/schemas/mobile.ui'
        mode:
          $ref: '#/components/schemas/mode.ui'
        theme:
          $ref: '#/components/schemas/theme.ui'
        user_account:
          $ref: '#/components/schemas/user_account'
      type: object
    settings:
      description: >-
        Einstellungen zum Konfigurieren des Bezahlvorgangs und des
        Zahlungsportals für einen Benutzer.
      properties:
        currency:
          $ref: '#/components/schemas/currency'
        external_id:
          $ref: '#/components/schemas/external_id'
        language:
          $ref: '#/components/schemas/language'
        mode:
          $ref: '#/components/schemas/mode.settings'
        payment_method:
          $ref: '#/components/schemas/payment_method'
        payment_widget:
          $ref: '#/components/schemas/payment_widget'
        project_id:
          $ref: '#/components/schemas/project_id'
        redirect_policy:
          $ref: '#/components/schemas/redirect_policy'
        return_url:
          $ref: '#/components/schemas/return_url'
        ui:
          $ref: '#/components/schemas/ui'
      required:
        - project_id
      type: object
    age.user:
      description: Alter des Benutzers.
      type: integer
    attributes.user:
      description: >-
        Benutzerattribute zum Filtern der Liste der Gegenstände; repräsentiert
        durch eine gültige Reihe von JSON-Objekten bestehend aus
        Schlüssel-Wert-Paaren.
      type: object
    country.user:
      properties:
        allow_modify:
          description: >-
            Legt fest, ob ein Benutzer das Land im Zahlungsportal ändern darf.
            Wenn `country.value` im Token übermittelt wird, ist der Wert
            standardmäßig auf `false` gestellt.
          type: boolean
        value:
          description: >-
            Ländercode, bestehend aus zwei Großbuchstaben gemäß [ISO 3166-1
            ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
          type: string
      type: object
    email.user:
      description: >-
        Das `user.email` Objekt ist ein integraler Bestandteil beim Aufbau von
        Betrugsbekämpfungsmodellen und trägt zur Erhöhung der Akzeptanzraten
        bei. Es ist sowohl für Xsolla als auch für Zahlungssysteme erforderlich.
        Falls der Parameter nicht übergeben wird, erscheint auf der
        Zahlungsseite das Pflichtfeld zur Eingabe der E-Mail. Ein Benutzer
        erhält einen Kaufbeleg an die im Parameter übergebene oder auf der
        Zahlungsseite eingegebene E-Mail.
      maxLength: 100
      properties:
        allow_modify:
          description: >-
            Legt fest, ob ein Benutzer seine E-Mail in der Zahlungsoberfläche
            eingeben kann. Falls der `user.email.value` Parameter im Token
            übergeben wird, ist der Wert standardmäßig `false`.
          type: boolean
        value:
          description: >-
            E-Mail-Adresse des Benutzers. Muss gemäß [RFC
            822](https://www.w3.org/Protocols/rfc822/#z8)-Protokoll gültig sein.
          type: string
      required:
        - value
      type: object
    id.user:
      properties:
        value:
          description: >-
            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](/de/doc/pay-station/references/faq/#faq_validation).
          type: string
      required:
        - value
      type: object
    is_legal.user:
      description: Legt fest, ob der Benutzer eine juristische Person ist.
      type: boolean
    legal:
      description: Objekt mit Angaben zur juristischen Person.
      properties:
        address:
          description: Vollständige Unternehmensanschrift.
          type: string
        country:
          description: >-
            Land des Unternehmenssitzes. Ländercode, bestehend aus 2
            Großbuchstaben gemäß [ISO 3166-1
            ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
          type: string
        name:
          description: Vollständiger Name des Unternehmens.
          type: string
        vat_id:
          description: Steuerliche Identifikationsnummer.
          type: string
      type: object
    legal.user:
      allOf:
        - description: >-
            Objekt mit Angaben zur juristischen Person. Objekt und alle seine
            Parameter sind erforderlich, falls für `user.is_legal` `true`
            festgelegt ist.
        - $ref: '#/components/schemas/legal'
    name.user:
      properties:
        allow_modify:
          description: >-
            Legt fest, ob ein Benutzer seine E-Mail in der Zahlungsoberfläche
            eingeben kann. Falls der `user.name.value` Parameter im Token
            übergeben wird, ist der Wert standardmäßig `false`.
          type: boolean
        value:
          description: Benutzername.
          type: string
      type: object
    phone.user:
      nullable: true
      properties:
        value:
          description: Telefonnummer des Benutzers.
          type: string
      type: object
    public_id.user:
      properties:
        value:
          description: >-
            Parameter, durch den der Benutzer eindeutig identifizierbar ist und
            der dem Benutzer bekannt ist (E-Mail, Benutzername, usw.). Gestattet
            dem Benutzer, Käufe außerhalb des Game-Stores zu tätigen (z. B. via
            Verkaufsterminals).
          type: string
      type: object
    steam_id.user:
      properties:
        value:
          description: Steam-ID.
          type: string
      type: object
    tracking_id.user:
      properties:
        value:
          description: "Eindeutige Benutzer-ID\_– wird in Marketingkampagnen verwendet. Kann Ziffern und lateinische Zeichen enthalten."
          maxLength: 32
          minLength: 32
          type: string
      type: object
    utm.user:
      description: Datenverkehrsattribute (Objekt).
      properties:
        utm_campaign:
          description: Kampagnenbezeichnung, ins Englische transliteriert oder übersetzt.
          type: string
        utm_content:
          description: Kampagneninhalt.
          type: string
        utm_medium:
          description: >-
            Datenverkehrskanal (kontextbezogene Anzeigen, mediale Anzeigen,
            E-Mail-Listen, usw.).
          type: string
        utm_source:
          description: Ursprung des Datenverkehrs.
          type: string
        utm_term:
          description: >-
            Kampagnen-Keyword. Falls festgelegt, basieren die Statistiken auf
            den Keywords, die für die Zielgruppenwerbung verwendet werden,
            anstatt auf spezifischen Suchanfragen. In Google Analytics ist der
            angegebene `utm_term` Teil des allgemeinen Berichts zu
            Suchbegriffen.
          type: string
      type: object
    user:
      description: Benutzerdaten (Objekt).
      properties:
        age:
          $ref: '#/components/schemas/age.user'
        attributes:
          $ref: '#/components/schemas/attributes.user'
        country:
          $ref: '#/components/schemas/country.user'
        email:
          $ref: '#/components/schemas/email.user'
        id:
          $ref: '#/components/schemas/id.user'
        is_legal:
          $ref: '#/components/schemas/is_legal.user'
        legal:
          $ref: '#/components/schemas/legal.user'
        name:
          $ref: '#/components/schemas/name.user'
        phone:
          $ref: '#/components/schemas/phone.user'
        public_id:
          $ref: '#/components/schemas/public_id.user'
        steam_id:
          $ref: '#/components/schemas/steam_id.user'
        tracking_id:
          $ref: '#/components/schemas/tracking_id.user'
        utm:
          $ref: '#/components/schemas/utm.user'
      required:
        - id
      type: object
    token:
      example:
        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
      properties:
        custom_parameters:
          $ref: '#/components/schemas/custom_parameters'
        purchase:
          $ref: '#/components/schemas/purchase'
        settings:
          $ref: '#/components/schemas/settings'
        user:
          $ref: '#/components/schemas/user'
      type: object
    mock_code:
      description: >-
        Ein zu reproduzierender Fehlercode beim Testen des Zahlungsvorgangs über
        PayPal in der Testumgebung. Funktioniert nur korrekt, wenn Sie den
        Parameter `"mode":"sandbox"` übermitteln.
      enum:
        - 1057
        - 1015
        - 3006
        - 1801
        - 1803
        - 1039
        - 3031
        - 1203
        - 3006
        - 1201
        - 1002
        - 1089
        - 2031
        - 1046
        - 5004
      type: integer
  requestBodies:
    charge-with-saved-account:
      content:
        application/json:
          example:
            purchase:
              description:
                value: currency purchase
              virtual_currency:
                quantity: 100
            settings:
              currency: USD
              external_id: ext123
              mode: sandbox
            user:
              ip: 111.11.11.11
              legal:
                address: 17 Crown Street London SW2 0JW United Kingdom
                country: GB
                name: My Awesome Company
                vat_id: GB111111111
              name: John Smith
          schema:
            properties:
              custom_parameters:
                $ref: '#/components/schemas/custom_parameters'
              purchase:
                description: Objekt, welches Angaben zum Kauf enthält.
                properties:
                  checkout:
                    description: Objekt, welches Angaben zur Bezahlung enthält.
                    properties:
                      amount:
                        description: Kaufbetrag.
                        format: float
                        type: number
                      currency:
                        description: >-
                          Kaufwährung. Währungscode, bestehend aus drei
                          Buchstaben gemäß [ISO
                          4217](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/).
                        type: string
                    type: object
                  description:
                    maxLength: 4000
                    properties:
                      value:
                        type: string
                    type: object
                  virtual_currency:
                    description: Objekt, welches Angaben zur virtuellen Währung enthält.
                    properties:
                      quantity:
                        description: Kaufbetrag in der virtuellen Währung.
                        format: float
                        type: number
                    type: object
                type: object
              settings:
                description: Objekt, welches die Einstellungen für den Kauf enthält.
                properties:
                  currency:
                    $ref: '#/components/schemas/currency'
                  external_id:
                    $ref: '#/components/schemas/external_id'
                  mock_code:
                    $ref: '#/components/schemas/mock_code'
                  mode:
                    description: >-
                      Legen Sie als Wert `sandbox` fest, um den Zahlungsvorgang
                      auszutesten. Entfernen Sie den Parameter für tatsächliche
                      Zahlungen.
                    type: string
                type: object
              user:
                description: Benutzerdaten (Objekt).
                properties:
                  ip:
                    description: IP-Adresse des Benutzers.
                    type: string
                  legal:
                    $ref: '#/components/schemas/legal'
                  name:
                    description: Benutzername.
                    type: string
                required:
                  - ip
                type: object
            type: object
      required: true
