Worldline Payment Initiation Service API

The Payment Initiation Service API from Worldline — 11 operation(s) for payment initiation service.

OpenAPI Specification

wordline-payment-initiation-service-api-openapi.yml Raw ↑
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 Payment Initiation Service API
  contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Payment Initiation Service
paths:
  /payments:
    post:
      security:
      - Authorization: []
      tags:
      - Payment Initiation 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: paymentInitiate
      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/PaymentInitiationRequest'
            examples:
              PSD2-SCT - Example request:
                value:
                  PaymentProduct:
                  - PSD2-SCT
                  PsuData:
                    AspspId: '20100'
                  CommonPaymentData:
                    EndToEndId: ID-0123456789
                    InitiatingPartyReferenceId: Ref-992098126
                    PreferredScaMethod:
                    - Redirect
                    Amount:
                      Amount: '123.45'
                      Currency: EUR
                    DebtorInformation:
                      Name: Bob Smith
                      Agent: 8QB2EN7P
                      Account:
                        SchemeName: IBAN
                        Identification: DE89370400440532013000
                        Currency: EUR
                    RemittanceInformation: Remittance Information
              PSD2-SCT - Minimal set of fields which will work for the majority of ASPSP's:
                value:
                  PaymentProduct:
                  - PSD2-SCT
                  PsuData:
                    AspspId: '20100'
                  CommonPaymentData:
                    EndToEndId: ID-7853389
                    InitiatingPartyReferenceId: Ref-88276166
                    Amount:
                      Amount: '1.00'
                      Currency: EUR
                    DebtorInformation:
                      Name: Juno Smith
                    RemittanceInformation: Remittance Information
              IDEAL - Payment with minimum fields:
                value:
                  PaymentProduct:
                  - IDEAL
                  CommonPaymentData:
                    Amount:
                      Amount: '1.00'
                    RemittanceInformation: iDEAL Standard Flow Minimum fields
                    RemittanceInformationStructured:
                      Reference: iDEALStandardFlow
              IDEAL - Payment with Debtor token:
                value:
                  PaymentProduct:
                  - IDEAL
                  CommonPaymentData:
                    Amount:
                      Amount: '8.00'
                    RemittanceInformation: iDEAL2.0 Transaction Standard Flow
                    RemittanceInformationStructured:
                      Reference: iDEALDebtortoken
                  IDEALPayments:
                    FlowType: Standard
                    UseDebtorToken: true
                    DebtorTokenCallbackUrl: https://merchantdomain.com/notification/v3
              IDEAL - Payment with iDEAL Checkout:
                value:
                  PaymentProduct:
                  - IDEAL
                  CommonPaymentData:
                    Amount:
                      Type: Fixed
                      Amount: '24.50'
                      AmountBreakdown:
                        OrderAmount: '20.50'
                        ShippingCost: '4.00'
                    RemittanceInformation: iDEAL2.0 FastCheckout Flow
                    RemittanceInformationStructured:
                      Reference: iDEALpurchase21
                  IDEALPayments:
                    FlowType: FastCheckout
                    ExpectedCheckoutData:
                      DebtorContactDetails:
                        FirstName: true
                        LastName: true
                        PhoneNumber: true
                        Email: true
                      ShippingAddress: true
                      BillingAddress: true
        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'
              examples:
                PSD2-SCT - Example response:
                  value:
                    CommonPaymentData:
                      PaymentStatus: Open
                      PaymentId: '16006288'
                      AspspPaymentId: 414c3547acf7422aab274e41e5446c81
                      InitiatingPartyReferenceId: Ref-992098126
                      PsuMessage: This is the ASPSP message for the psu
                    Links:
                      RedirectUrl:
                        Href: https://www.example.org/bankwebsite
                      GetPaymentStatus:
                        Href: https://xs2a.awltest.de/xs2a/routingservice/services/ob/pis/v3/payments/16006288/status
                    UseWaitingScreen: false
                IDEAL - Payment with minimum fields:
                  value:
                    CommonPaymentData:
                      ExpiryDateTimestamp: '2023-12-29T20:38:45.925Z'
                      PaymentStatus: Open
                      PaymentId: '142641'
                      AspspPaymentId: 0001143558019460
                    Links:
                      RedirectUrl:
                        Href: https://www.example.org/idealwebsite
                      GetPaymentStatus:
                        Href: https://digitalroutingservice.awltest.de/xs2a/routingservice/services/ob/pis/v3/payments/142641/status
                    UseWaitingScreen: false
                IDEAL - Payment with Debtor token:
                  value:
                    CommonPaymentData:
                      ExpiryDateTimestamp: '2024-02-07T11:12:09.522Z'
                      PaymentStatus: Open
                      PaymentId: '171203'
                      AspspPaymentId: 0001090703303174
                    Links:
                      RedirectUrl:
                        Href: https://www.example.org/idealwebsite
                      GetPaymentStatus:
                        Href: https://digitalroutingservice.awltest.de/xs2a/routingservice/services/ob/pis/v3/payments/171203/status
                    UseWaitingScreen: false
                IDEAL - Payment with iDEAL Checkout:
                  value:
                    CommonPaymentData:
                      ExpiryDateTimestamp: '2024-02-14T21:33:58.919Z'
                      PaymentStatus: Open
                      PaymentId: '174142'
                      AspspPaymentId: 0001077680035886
                    Links:
                      RedirectUrl:
                        Href: https://www.example.org/idealwebsite
                      GetPaymentStatus:
                        Href: https://digitalroutingservice.awltest.de/xs2a/routingservice/services/ob/pis/v3/payments/174142/status
                    UseWaitingScreen: false
        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
  /payments/{paymentId}/status:
    get:
      security:
      - Authorization: []
      tags:
      - Payment Initiation Service
      summary: Retrieve payment status (in combination with status notifications)
      description: "This GET request can be used to retrieve payment status. It is recommended to implement status \nnotifications as a primary way to get payment status updates (see the notification Swagger file). \nPlease note that for iDEAL 2.0 payments, implementing status notifications should be the primary way to retrieve status, \nand active GET requests should only be made under certain conditions (see guidelines in the Open Banking API for \niDEAL Implementation Guide, under section \"Retrieving Payment Status\").\n"
      operationId: paymentStatus
      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'
  /payments/{paymentId}/confirmation:
    post:
      security:
      - Authorization: []
      summary: Confirmation of the payment request by the PISP
      tags:
      - Payment Initiation 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: paymentConfirmation
      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'
  /payments/{paymentId}/identification:
    post:
      security:
      - Authorization: []
      summary: Payment identification request
      tags:
      - Payment Initiation 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: paymentIdentification
      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'
  /payments/{paymentId}/qrcode:
    get:
      security:
      - Authorization: []
      tags:
      - Payment Initiation Service
      summary: Retrieve QR code
      parameters:
      - $ref: '#/components/parameters/paymentId'
      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/PaymentQrCodeResponse'
  /payments/{paymentId}/authorisations:
    post:
      security:
      - Authorization: []
      summary: Payment authorisation request
      tags:
      - Payment Initiation 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: paymentAuthorisation
      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'
  /payments/{paymentId}/authorisations/{authorisationId}:
    put:
      security:
      - Authorization: []
      summary: Payment authorisation request
      tags:
      - Payment Initiation Service
      description: 'Use this operation to change the authorisation resource.

        '
      operationId: paymentAuthorisationUpdate
      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'
  /payments/{paymentId}:
    delete:
      security:
      - Authorization: []
      summary: Payment cancellation request
      tags:
      - Payment Initiation 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: paymentCancellation
      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'
  /payments/{paymentId}/cancellation-identification:
    post:
      security:
      - Authorization: []
      summary: Payment cancellation identification request
      tags:
      - Payment Initiation Service
      description: 'Use this operation to identify a Payment Service User in a decoupled approach.

        '
      operationId: paymentCancellationIdentification
      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'
  /payments/{paymentId}/cancellation-authorisations:
    post:
      security:
      - Authorization: []
      tags:
      - Payment Initiation Service
      summary: Payment cancellation authorisation request
      description: 'Use this operation to authorise a Payment Service User (PSU) explicitly.

        '
      operationId: paymentCancellationAuthorisation
      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'
  /payments/{paymentId}/cancellation-authorisations/{authorisationId}:
    put:
      security:
      - Authorization: []
      tags:
      - Payment Initiation Service
      summary: Payment cancellation authorisation request update
      description: 'Use this operation to update the authorisation resource.

        '
      operationId: paymentCancellationAuthorisationUpdate
      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 

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