Worldline Periodic Payment Initiation Service (Extended service) API

swagger: '2.0'
info:
  description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms.

    Additional APIs are under construction and planned to be available in 2026.'
  version: 2.41.1
  title: Worldline Card Issuing Account - AccountState Periodic Payment Initiation Service (Extended service) API
  contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Periodic Payment Initiation Service (Extended service)
paths:
  /periodic-payments:
    post:
      security:
      - Authorization: []
      tags:
      - Periodic Payment Initiation Service (Extended service)
      summary: Payment initiation request
      description: 'Use this operation to initiate a payment on behalf of the Payment

        Service User. Strong customer authentication might be required by the ASPSP,

        the response will indicate which step is required to complete the payment.

        '
      operationId: periodicPaymentInitiate
      parameters:
      - $ref: '#/components/parameters/confirmForNotification'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/InitiatingPartyNotificationUrl'
      - $ref: '#/components/parameters/NotificationVersion'
      - $ref: '#/components/parameters/InitiatingPartyReturnUrl'
      - $ref: '#/components/parameters/UseAuthorisationLandingPages'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/AppRedirectPreferred'
      - $ref: '#/components/parameters/PsuId'
      - $ref: '#/components/parameters/LastLogin'
      - $ref: '#/components/parameters/PsuIpAddress'
      - $ref: '#/components/parameters/PsuIpPort'
      - $ref: '#/components/parameters/HttpMethod'
      - $ref: '#/components/parameters/HttpHeaderUserAgent'
      - $ref: '#/components/parameters/HttpHeaderReferer'
      - $ref: '#/components/parameters/HttpHeaderAccept'
      - $ref: '#/components/parameters/HttpHeaderAcceptCharset'
      - $ref: '#/components/parameters/HttpHeaderAcceptEncoding'
      - $ref: '#/components/parameters/HttpHeaderAcceptLanguage'
      - $ref: '#/components/parameters/DeviceId'
      - $ref: '#/components/parameters/GeoLocation'
      - $ref: '#/components/parameters/Signature'
      - $ref: '#/components/parameters/Digest'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PeriodicPaymentInitiationRequest'
            examples:
              PSD2-SCT - Example request:
                value:
                  PaymentProduct:
                  - PSD2-SCT
                  PsuData:
                    AspspId: '20220'
                  CommonPaymentData:
                    EndToEndId: ID-0123456789
                    PreferredScaMethod:
                    - Redirect
                    Amount:
                      Amount: '67.45'
                      Currency: EUR
                    DebtorInformation:
                      Name: John Smith
                      Agent: 8QB2EN7P
                      Account:
                        SchemeName: IBAN
                        Identification: DE89370400440532013000
                        Currency: EUR
                    RemittanceInformation: Remittance Information
                    PeriodRules:
                      StartDateTime: '2022-10-25T08:15:00.856Z'
                      Frequency: MNTH
        required: false
      responses:
        201:
          description: 'Created

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
            AspspScaApproach:
              $ref: '#/components/headers/AspspScaApproach'
            Signature:
              $ref: '#/components/headers/Signature'
            Digest:
              $ref: '#/components/headers/Digest'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentInitiationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
      x-codegen-request-body-name: body
  /periodic-payments/{paymentId}/status:
    get:
      security:
      - Authorization: []
      tags:
      - Periodic Payment Initiation Service (Extended service)
      summary: Status of the payment request
      description: 'Use this operation to retrieve the status of a payment.

        '
      operationId: periodicPaymentStatus
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/confirm'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/PsuIpAddress'
      - $ref: '#/components/parameters/Signature'
      - $ref: '#/components/parameters/Digest'
      responses:
        200:
          description: 'Successful

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
            AspspScaApproach:
              $ref: '#/components/headers/AspspScaApproach'
            Signature:
              $ref: '#/components/headers/Signature'
            Digest:
              $ref: '#/components/headers/Digest'
            PaymentStatusSource:
              $ref: '#/components/headers/PaymentStatusSource'
            DebtorDataSource:
              $ref: '#/components/headers/DebtorDataSource'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDetailedInformation'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/confirmation:
    post:
      security:
      - Authorization: []
      summary: Confirmation of the payment request by the PISP
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'This Api is used to confirm a payment. Confirmation is required

        when the link ''ConfirmationRequired'' is returned. Confirmation of a payment can

        be required in two cases 1) When its required by the ASPSP standard 2) when

        a payment fee is involved.

        '
      operationId: periodicPaymentConfirmation
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmationRequest'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentConfirmationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/identification:
    post:
      security:
      - Authorization: []
      summary: Payment identification request
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'Use this operation to identify a PSU in decoupled approach. The

        response of the post payments api will provide a link to this api in the ''PostIdentificationForDecoupled''

        field if this step is required.

        '
      operationId: PeriodicPaymentIdentification
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentIdentificationRequest'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIdentificationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/authorisations:
    post:
      security:
      - Authorization: []
      summary: Payment authorisation request
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'Use this operation to authorise a PSU explicitly. This has to be used if multiple PSU''s have to authorise

        the payment. Background information: If only one PSU has to authorise, this step is started implicitly by

        the post payments api.

        '
      operationId: periodicPaymentAuthorisation
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationRequest'
      responses:
        201:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorisationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/authorisations/{authorisationId}:
    put:
      security:
      - Authorization: []
      summary: Payment authorisation request
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'Use this operation to change the authorisation resource.

        '
      operationId: periodicPaymentAuthorisationUpdate
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/authorisationId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationUpdateRequest'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorisationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}:
    delete:
      security:
      - Authorization: []
      summary: Payment cancellation request
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'Use this operation to cancel a payment on behalf of the

        Payment Service User. Strong Customer Authentication might be required by

        the ASPSP, the response will indicate which step is required to complete the

        cancellation.

        '
      operationId: periodicPaymentCancellation
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/InitiatingPartyReturnUrl'
      - $ref: '#/components/parameters/AspspPsuId'
      - $ref: '#/components/parameters/AspspPsuIdType'
      - $ref: '#/components/parameters/AspspPsuCorporateId'
      - $ref: '#/components/parameters/AspspPsuCorporateIdType'
      - $ref: '#/components/parameters/UseAuthorisationLandingPages'
      - $ref: '#/components/parameters/Locale'
      - $ref: '#/components/parameters/PsuIpAddress'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
            AspspScaApproach:
              $ref: '#/components/headers/AspspScaApproach'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentCancellationResponse'
        204:
          $ref: '#/components/responses/204'
        405:
          $ref: '#/components/responses/405'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/cancellation-identification:
    post:
      security:
      - Authorization: []
      summary: Payment cancellation identification request
      tags:
      - Periodic Payment Initiation Service (Extended service)
      description: 'Use this operation to identify a PSU in decoupled approach.

        '
      operationId: periodicPaymentCancellationIdentification
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentIdentificationRequest'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIdentificationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/cancellation-authorisations:
    post:
      security:
      - Authorization: []
      tags:
      - Periodic Payment Initiation Service (Extended service)
      summary: Payment cancellation authorisation request
      description: 'Use this operation to authorise a PSU explicitly.

        '
      operationId: periodicPaymentCancellationAuthorisation
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationRequest'
      responses:
        201:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorisationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
  /periodic-payments/{paymentId}/cancellation-authorisations/{authorisationId}:
    put:
      security:
      - Authorization: []
      tags:
      - Periodic Payment Initiation Service (Extended service)
      summary: Payment cancellation authorisation request update
      description: 'Use this operation to update the authorisation resource.

        '
      operationId: periodicPaymentCancellationAuthorisationUpdate
      parameters:
      - $ref: '#/components/parameters/paymentId'
      - $ref: '#/components/parameters/authorisationId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationUpdateRequest'
      responses:
        200:
          description: 'OK

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorisationResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        502:
          $ref: '#/components/responses/502'
        503:
          $ref: '#/components/responses/503'
        511:
          $ref: '#/components/responses/511'
components:
  parameters:
    AspspPsuId:
      name: AspspPsuId
      in: header
      description: 'PSU’s Id at ASPSP. Allows the unique identification of the PSU at

        the ASPSP.

        '
      schema:
        type: string
      example: Psu-12345
    Signature:
      name: Signature
      in: header
      description: 'Conditionally required for iDEAL payments. The signature in the request should include a keyId with the value of fingerprint of the certificate

        '
      schema:
        type: string
    DeviceId:
      name: DeviceId
      in: header
      description: 'UUID (Universally Unique Identifier) for a device, which is used by

        the PSU. UUID identifies either a device or a device dependant

        application installation. In case of an installation identification

        this ID need to be unaltered until removal from device.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    PsuIpAddress:
      name: PsuIpAddress
      in: header
      description: 'PSU Session information.


        The forwarded IP Address header field consists of the corresponding

        HTTP request IP Address field between PSU and TPP . It shall be

        contained if and only if this request was actively initiated by the

        PSU.

        '
      schema:
        maxLength: 35
        minLength: 1
        type: string
    InitiatingPartyReturnUrl:
      name: InitiatingPartyReturnUrl
      in: header
      description: 'The callback URL for the redirection back to the initiating party

        after authorization.

        '
      schema:
        maxLength: 4000
        minLength: 1
        type: string
        example: https://www.example.org
    AspspPsuCorporateIdType:
      name: AspspPsuCorporateIdType
      in: header
      description: 'This is describing the type of the identification needed by the

        ASPSP to identify the PsuCorporate-ID content.

        '
      schema:
        type: string
    LastLogin:
      name: LastLogin
      in: header
      description: 'PSU Session information.


        The time when the PSU last logged in with the TPP. ISO 8601 DateTime.

        '
      schema:
        type: string
        format: date-time
    Digest:
      name: Digest
      in: header
      description: Is contained if and only if the `Signature` element is contained in the header of the request.
      schema:
        type: string
      example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
    PsuId:
      name: PsuId
      in: header
      schema:
        type: string
      description: 'If this field is filled the Open Banking Service will try to

        retrieve previously stored information to complete the

        payment. The Open Banking Solution will:

        * check for a pre authentication token in case pre-authentication is available for the ASPSP.

        * check for debtor token in case of IDEAL payments

        '
    HttpHeaderAcceptLanguage:
      name: HttpHeaderAcceptLanguage
      in: header
      description: 'PSU Session information.


        The forwarded IP Accept header fields consist of the corresponding

        HTTP request Accept header fields between PSU and TPP.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    AppRedirectPreferred:
      name: AppRedirectPreferred
      in: header
      schema:
        type: boolean
        default: false
      description: 'If set to ''true'' the Open Banking Service will try to steer the flow towards an App redirect for the authentication of the PSU and authorization of the payment.

        This can potentially improve the user journey as the banking application may use biometrics for SCA and skip the identification process if the user is already logged in.


        NOTE that, depending on the implementation of the ASPSP, it may so happen that the flows breaks if the user does not have the banking application installed on their mobile device.

        '
    InitiatingPartyNotificationUrl:
      name: InitiatingPartyNotificationUrl
      in: header
      description: 'The URL which will be used for notification service request. The Open Banking Service supports two ways in which this field can be filled:

        * **Option A)** with an URL ending on /v2 or /v3, indicating the version of the Notification API implemented by the Initiating Party. In this case the URL called for notifications will be extended with /notification/status by the Open Banking Service. The ''NotificationVersion'' field MUST NOT be filled.

        * **Option B)** with a full URL. The version information MUST BE provided in the ''NotificationVersion'' field. In this case the provided URL will not be extended, and used as-is.

        '
      examples:
        Option A:
          value: https://www.example.org/myendpoint/v3
        Option B:
          value: https://www.example.org/myendpoint/notification
      schema:
        maxLength: 4000
        minLength: 1
        type: string
    confirm:
      name: confirm
      in: query
      description: 'If set to ''true'' the transaction will be immediately confirmed

        by the Open Banking Service if confirmation of the payment by the Initiating Party is required by the ASPSP.

        '
      schema:
        type: string
    authorisationId:
      name: authorisationId
      in: path
      required: true
      schema:
        type: string
      example: aid-4846
      description: 'The Id used by the Open Banking Service to refer to an authorisation resource.

        '
    HttpHeaderUserAgent:
      name: HttpHeaderUserAgent
      in: header
      description: 'PSU Session information.


        The forwarded Agent header field of the HTTP request between PSU

        and TPP.


        Required if

        * the `PaymentProduct`equals `IDEAL`

        * `PsuId`is provided

        * `UseDebtorToken` does not equal `false`

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    GeoLocation:
      name: GeoLocation
      in: header
      description: 'The forwarded Geo Location of the corresponding http request

        between PSU and TPP.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    MessageCreateDateTime:
      name: MessageCreateDateTime
      in: header
      description: 'The message create date time.


        ISO 8601 DateTime.

        '
      required: true
      schema:
        type: string
        format: date-time
      example: '2020-09-25T08:15:00.856Z'
    AspspPsuCorporateId:
      name: AspspPsuCorporateId
      in: header
      description: 'Identification of a Corporate in the Online Channels.

        '
      schema:
        type: string
    confirmForNotification:
      name: confirm
      in: query
      description: 'If set to ''true'' the transaction will be immediately confirmed by the Open Banking Service if confirmation of the payment by the Initiating Party is required by the ASPSP.

        <br>**Note:** This field is only applicable when the notification service is used by the Initiating Party to receive the status of the payment. When the notification is not used this flag can be set in the GET status API.

        '
      schema:
        type: string
    NotificationVersion:
      name: NotificationVersion
      in: header
      description: "The version of the Notification API, implemented by the Initiating Party, which shall be used for notification service request. Can be filled with v2 or v3. This field is only applicable if option 'B' is chosen, see 'InitiatingPartyNotificationUrl' description. \n"
      example: v3
      schema:
        type: string
    HttpHeaderAccept:
      name: HttpHeaderAccept
      in: header
      description: 'PSU Session information.


        The forwarded IP Accept header fields consist of the corresponding

        HTTP request Accept header fields between PSU and TPP.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    HttpHeaderReferer:
      name: HttpHeaderReferer
      in: header
      description: 'PSU Session information.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    Locale:
      name: Locale
      in: header
      schema:
        type: string
      description: '2-digit ISO-639 code for the language in which the Bank Selection Interface are displayed.


        For special languages can be used 5-digit code like nl-BE, where first is ISO-639 langauge code and the second is ISO-3166 country code.


        If not set, the language of the Bank Selection Interface is taken over from the end user’s browser configuration or the system configuration of the Bank Selection Interface server.

        '
    HttpMethod:
      name: HttpMethod
      in: header
      description: 'PSU Session information.


        HTTP method used at the PSU-TPP interface. Available values - GET,

        POST, PUT, DELETE.

        '
      schema:
        maxLength: 6
        minLength: 3
        type: string
    HttpHeaderAcceptEncoding:
      name: HttpHeaderAcceptEncoding
      in: header
      description: 'PSU Session information.


        The forwarded IP Accept header fields consist of the corresponding

        HTTP request Accept header fields between PSU and TPP.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    AspspPsuIdType:
      name: AspspPsuIdType
      in: header
      description: 'Type of the Aspsp PSU-ID, needed in scenarios where PSUs have

        several PSU-IDs as access possibility.

        '
      schema:
        type: string
    X-Request-ID:
      name: X-Request-ID
      in: header
      description: 'UUID for unique request identification.

        '
      required: true
      schema:
        maxLength: 36
        minLength: 1
        type: string
      example: abcdef2e-3000-4000-88cc-ae40e3b113d7
    HttpHeaderAcceptCharset:
      name: HttpHeaderAcceptCharset
      in: header
      description: 'PSU Session information.


        The forwarded IP Accept header fields consist of the corresponding

        HTTP request Accept header fields between PSU and TPP.

        '
      schema:
        maxLength: 500
        minLength: 1
        type: string
    paymentId:
      name: paymentId
      in: path
      description: 'The Id used by the Open Banking Service to refer to a payment.


        Optionally the payment can also be refered by the **InitiatingPartyReferenceId** or the **EndToEndId**, to do so start with **ref** or **e2e** prefixes followed by the respective identifier.

        '
      required: true
      schema:
        type: string
      example: 486215
    PsuIpPort:
      name: PsuIpPort
      in: header
      description: 'PSU Session information.


        The forwarded IP Port header field consists of the corresponding

        HTTP request IP Port field between PSU and TPP, if available.

        '
      schema:
        maxLength: 5
        minLength: 1
        type: string
    UseAuthorisationLandingPages:
      name: UseAuthorisationLandingPages
      in: header
      schema:

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-periodic-payment-initiation-service-extended-service-api-openapi.yml