openapi: 3.0.3
info:
  title: xBezahldienste-API (GiroCheckout)
  version: 1.0.1
  description: >
    Minimale xBezahldienste-kompatible API auf Basis der GiroCheckout Paypage.
    Nur Client-Credentials-Flow; Tokens sind opaque.
    Übliche Vorgehensweise:
    * Zuerst ein Token abrufen (token-Endpunkt)
    * Dann unter Angabe des Tokens im Bearer-Header, Zahlungstransaktion erstellen (Endpunkt paymenttransaction/{originatorId}/{endPointId})
    * Wichtig ist die Angabe der requestId und der redirectUrl (das ist die URL, zu der der Kunde nach Abschluss der Zahlung zurückgeleitet wird).
    * Sie erhalten eine PaymentTransaction mit transactionUrl (dienst zur Statusabfrage der Zahlung) und transactionRedirectUrl (hierhin müssen Sie den Kunden weiterleiten, damit dieser die Zahlung abschließen kann).
    * Nach Abschluss der Zahlung wird der Kunde zur vorher angegebenen redirectUrl weitergeleitet.
    * Dort sollten Sie dann den Status der Zahlung abfragen (Endpunkt paymenttransaction/{originatorId}/{endPointId}/{transactionId}) und das finale Ergebnis anzeigen oder verarbeiten.
servers:
  - url: https://payment.girosolution.de/api/xbezahldienste/{...endpunkt}
    description: Produktiver Host, nutzen Sie den angegebenen Präfix und ergänzen dann die u.a. URL des Endpunktes
tags:
  - name: Bezahldienst
    description: Endpunkte für Zahlungstransaktionen
  - name: Betrieb
    description: Status-Endpunkte
  - name: OAuth2
    description: Token-Endpunkt
paths:
  /xbezahldienste/auth/getAccessToken:
    post:
      tags:
        - OAuth2
      summary: Token-Endpunkt (Client-Credentials)
      description: >
        Nutzen Sie diesen Endpunkt, um ein Zugriffstoken für die anderen Aufrufe zu erhalten. Es wird nur der Client-Credentials-Flow von OAuth2 unterstützt.
        Gibt ein opakes Zugriffstoken (kein JWT) unter Verwendung von client_credentials zurück.
        Unterstützt application/x-www-form-urlencoded oder JSON-Body.
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/TokenRequest'
      responses:
        '200':
          description: Token-Antwort
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '400':
          description: Ungültige Anfrage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenError'
        '401':
          description: Ungültiger Client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenError'

  /xbezahldienste/paymenttransaction/{originatorId}/{endPointId}:
    post:
      tags:
        - Bezahldienst
      summary: PaymentTransaction erstellen (Paypage-Initialisierung)
      security:
        - OAuth2: [post]
      parameters:
        - name: originatorId
          in: path
          description: "Zuordnung zur GiroCheckout Merchant ID (Verkäufer-ID). Die Verkäufer-ID ist im GiroCockpit-Konto des Kunden zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
        - name: endPointId
          in: path
          description: "Zuordnung zur GiroCheckout Projekt-ID. Die Projekt-ID ist im GiroCockpit-Konto des Kunden im entsprechenden Zahlungsprojekt zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '200':
          description: In Ordnung
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentTransaction'
        '400':
          $ref: '#/components/responses/400Error'
        '404':
          $ref: '#/components/responses/404Error'
        '504':
          $ref: '#/components/responses/504Error'

  /xbezahldienste/paymenttransaction/{originatorId}/{endPointId}/{transactionId}:
    get:
      tags:
        - Bezahldienst
      summary: PaymentTransaction-Status abrufen
      security:
        - OAuth2: [read]
      parameters:
        - name: originatorId
          in: path
          description: "Zuordnung zur GiroCheckout Merchant ID (Verkäufer-ID). Die Verkäufer-ID ist im GiroCockpit-Konto des Kunden zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
        - name: endPointId
          in: path
          description: "Zuordnung zur GiroCheckout Projekt-ID. Die Projekt-ID ist im GiroCockpit-Konto des Kunden im entsprechenden Zahlungsprojekt zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
        - $ref: '#/components/parameters/TransactionId'
      responses:
        '200':
          description: In Ordnung
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentTransaction'
        '404':
          $ref: '#/components/responses/404Error'
        '504':
          $ref: '#/components/responses/504Error'

  /xbezahldienste/status:
    get:
      tags:
        - Betrieb
      summary: Dienststatus
      security:
        - OAuth2: [read]
      responses:
        '200':
          $ref: '#/components/responses/200Healthy'
        '403':
          $ref: '#/components/responses/403Error'
        '504':
          $ref: '#/components/responses/504Error'

  /xbezahldienste/status/{originatorId}/{endPointId}:
    get:
      tags:
        - Betrieb
      summary: Status für spezifische Konfiguration
      security:
        - OAuth2: [read]
      parameters:
        - name: originatorId
          in: path
          description: "Zuordnung zur GiroCheckout Merchant ID (Verkäufer-ID). Die Verkäufer-ID ist im GiroCockpit-Konto des Kunden zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
        - name: endPointId
          in: path
          description: "Zuordnung zur GiroCheckout Projekt-ID. Die Projekt-ID ist im GiroCockpit-Konto des Kunden im entsprechenden Zahlungsprojekt zu finden."
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 36
            pattern: '^[\w\d-]+$'
      responses:
        '200':
          $ref: '#/components/responses/200Healthy'
        '403':
          $ref: '#/components/responses/403Error'
        '504':
          $ref: '#/components/responses/504Error'

components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /xbezahldienste/auth/getAccessToken
          scopes:
            post: PaymentRequest senden
            read: PaymentTransaction-Status lesen
            admin: Admin-Operationen

  parameters:
    OriginatorId:
      name: originatorId
      in: path
      description: "Zuordnung zur GiroCheckout Merchant ID (Verkäufer-ID). Die Verkäufer-ID ist im GiroCockpit-Konto des Kunden zu finden."
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 36
        pattern: '^[\w\d-]+$'
    EndPointId:
      name: endPointId
      in: path
      description: "Zuordnung zur GiroCheckout Projekt-ID. Die Projekt-ID ist im GiroCockpit-Konto des Kunden im entsprechenden Zahlungsprojekt zu finden."
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 36
        pattern: '^[\w\d-]+$'
    TransactionId:
      name: transactionId
      in: path
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 44
        pattern: '^[\w\d-]+$'

  schemas:
    PaymentTransaction:
      type: object
      required:
        - paymentInformation
      additionalProperties: false
      properties:
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        paymentRequest:
          $ref: '#/components/schemas/PaymentRequest'

    PaymentInformation:
      type: object
      required:
        - transactionUrl
        - transactionRedirectUrl
        - transactionId
        - paymentRequest
        - status
      additionalProperties: false
      properties:
        transactionUrl:
          type: string
          format: uri
          minLength: 1
          maxLength: 2082
        transactionRedirectUrl:
          type: string
          format: uri
          minLength: 1
          maxLength: 5000
        transactionId:
          type: string
          minLength: 1
          maxLength: 44
          pattern: '^[\w\d-]+$'
        transactionReference:
          type: string
          minLength: 1
          maxLength: 36
          pattern: '^[\w\d-]+$'
        transactionTimestamp:
          type: string
          format: date-time
        paymentMethod:
          type: string
          enum:
            - GIROPAY
            - PAYDIRECT
            - CREDITCARD
            - PAYPAL
            - OTHER
        paymentMethodDetail:
          type: string
          minLength: 1
          maxLength: 36
          pattern: '^[\w\d-]+$'
        status:
          type: string
          enum:
            - INITIAL
            - PAYED
            - FAILED
            - CANCELED
        statusDetail:
          type: string
          minLength: 0
          maxLength: 99
          pattern: '^[\w\d-]+$'

    PaymentRequest:
      type: object
      required:
        - requestId
        - requestTimestamp
        - currency
        - grosAmount
        - redirectUrl
        - items
      additionalProperties: false
      properties:
        requestId:
          type: string
          minLength: 1
          maxLength: 36
          pattern: '^[\w\d-]+$'
        requestTimestamp:
          type: string
          format: date-time
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: '^[\w]+$'
        grosAmount:
          type: number
          format: double
          minimum: 0
          maximum: 999999
          exclusiveMinimum: true
        purpose:
          type: string
          minLength: 0
          maxLength: 27
          pattern: '^[\w\d\s-]+$'
        description:
          type: string
          minLength: 0
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        redirectUrl:
          type: string
          format: uri
          minLength: 1
          maxLength: 2082
        items:
          type: array
          minItems: 1
          maxItems: 99
          items:
            $ref: '#/components/schemas/PaymentItem'
        requestor:
          $ref: '#/components/schemas/Requestor'

    PaymentItem:
      type: object
      required:
        - id
        - reference
        - taxRate
        - quantity
        - totalNetAmount
        - totalTaxAmount
        - singleNetAmount
        - singleTaxAmount
      additionalProperties: false
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 36
          pattern: '^[\w\d-]+$'
        reference:
          type: string
          minLength: 1
          maxLength: 36
          pattern: '^[\w\d-]+$'
        description:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        taxRate:
          type: number
          format: double
          minimum: 0
          maximum: 100
        quantity:
          type: integer
          format: int64
          minimum: 1
          maximum: 999999
        totalNetAmount:
          type: number
          format: double
          minimum: 0
          exclusiveMinimum: true
          maximum: 999999
        totalTaxAmount:
          type: number
          format: double
          minimum: 0
          maximum: 999999
        singleNetAmount:
          type: number
          format: double
          minimum: 0
          exclusiveMinimum: true
          maximum: 999999
        singleTaxAmount:
          type: number
          format: double
          minimum: 0
          maximum: 999999
        bookingData:
          type: object
          additionalProperties:
            type: string
            minLength: 0
            maxLength: 250
            pattern: '^[\w\d\s-,.]+$'

    Requestor:
      type: object
      required:
        - name
        - firstName
        - isOrganization
        - address
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        firstName:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        gender:
          type: string
          enum:
            - M
            - F
            - D
        isOrganization:
          type: boolean
        organizationName:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        address:
          $ref: '#/components/schemas/Address'

    Address:
      type: object
      additionalProperties: false
      properties:
        street:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,.]+$'
        houseNumber:
          type: string
          minLength: 0
          maxLength: 20
          pattern: '^[\w\d-]+$'
        addressLine:
          type: array
          minItems: 0
          maxItems: 9
          items:
            type: string
            minLength: 1
            maxLength: 250
            pattern: '^[\w\d\s-,.:]+$'
        postalCode:
          type: string
          minLength: 5
          maxLength: 5
          pattern: '^[\d]+$'
        city:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s-,]+$'
        country:
          type: string
          minLength: 2
          maxLength: 2
          pattern: '^[\w]+$'

    SystemResponse:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          minLength: 1
          maxLength: 2082
        status:
          type: integer
          format: int32
          minimum: 100
          maximum: 511
        title:
          type: string
          minLength: 1
          maxLength: 250
          pattern: '^[\w\d\s.-]+$'
        detail:
          type: string
          minLength: 1
          maxLength: 2000
          pattern: '^[\w\d\s-,.]+$'
        functionalCode:
          type: string
          enum:
            - NO_VALID_ORIGINATOR_OR_DESTINATION
            - PAYMENT_EXISTS
            - CALCULATION_ERROR
            - BOOKING_DATA_MISSING
            - UNSPECIFIED
            - FORBIDDEN

    TokenRequest:
      type: object
      required:
        - grant_type
        - client_id
        - client_secret
      additionalProperties: false
      properties:
        grant_type:
          type: string
          description: Wir unterstützen nur den Client-Credentials-Flow.
          enum:
            - client_credentials # Only client_credentials is supported
        client_id:
          type: string
          description: Diese Information erhalten Sie vom GiroCheckout-Support, wenn Sie dort die Aktivierung der xBezahldienste-Schnittstelle beantragen.
          minLength: 1
          maxLength: 128
        client_secret:
          type: string
          description: Diese Information erhalten Sie vom GiroCheckout-Support, wenn Sie dort die Aktivierung der xBezahldienste-Schnittstelle beantragen.
          minLength: 1
          maxLength: 256
        scope:
          type: string

    TokenResponse:
      type: object
      required:
        - access_token
        - token_type
        - expires_in
      additionalProperties: false
      properties:
        access_token:
          type: string
        token_type:
          type: string
          example: Bearer
        expires_in:
          type: integer
        scope:
          type: string

    TokenError:
      type: object
      required:
        - error
      additionalProperties: false
      properties:
        error:
          type: string
        error_description:
          type: string

  responses:
    200Healthy:
      description: In Ordnung
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SystemResponse'
          example:
            type: "https://api.girocheckout.de/girocheckout:xbezahldienste:start"
            status: 200
            title: "In Ordnung"
            detail: "Alles ist in Betrieb"

    400Error:
      description: Ungültige Anfrage
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SystemResponse'
          example:
            type: "https://api.girocheckout.de/girocheckout:xbezahldienste:start"
            status: 400
            title: "Ungültige Anfrage"
            detail: "Erforderliches Feld fehlt"
            functionalCode: "BOOKING_DATA_MISSING"

    403Error:
      description: Verboten
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SystemResponse'
          example:
            type: "https://api.girocheckout.de/girocheckout:xbezahldienste:start"
            status: 403
            title: "Zugriff Verboten"
            detail: "Authentifizierung fehlgeschlagen."
            functionalCode: "FORBIDDEN"

    404Error:
      description: Nicht gefunden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SystemResponse'
          example:
            type: "https://api.girocheckout.de/girocheckout:xbezahldienste:start"
            status: 404
            title: "Nicht gefunden"
            detail: "Ziel-ID unbekannt."
            functionalCode: "NO_VALID_ORIGINATOR_OR_DESTINATION"

    504Error:
      description: Dienst nicht verfügbar
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SystemResponse'
          example:
            type: "https://api.girocheckout.de/girocheckout:xbezahldienste:start"
            status: 504
            title: "Dienst vorübergehend nicht verfügbar"
            detail: "Interner Serverfehler."
            functionalCode: "UNSPECIFIED"
