Worldline

Worldline Periodic Payment Initiation Service (Extended service) API

The Periodic Payment Initiation Service (Extended service) API from Worldline — 10 operation(s) for periodic payment initiation service (extended service).

GitHub OpenAPI

Operations 10

POST /periodic-payments Payment initiation request #
GET /periodic-payments/{paymentId}/status Status of the payment request #
POST /periodic-payments/{paymentId}/confirmation Confirmation of the payment request by the PISP #
POST /periodic-payments/{paymentId}/identification Payment identification request #
POST /periodic-payments/{paymentId}/authorisations Payment authorisation request #
PUT /periodic-payments/{paymentId}/authorisations/{authorisationId} Payment authorisation request #
DELETE /periodic-payments/{paymentId} Payment cancellation request #
POST /periodic-payments/{paymentId}/cancellation-identification Payment cancellation identification request #
POST /periodic-payments/{paymentId}/cancellation-authorisations Payment cancellation authorisation request #
PUT /periodic-payments/{paymentId}/cancellation-authorisations/{authorisationId} Payment cancellation authorisation request update #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-periodic-payment-initiation-service-extended-service-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/wordline-periodic-payment-initiation-service-extended-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wordline-periodic-payment-initiation-service-extended-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Open Banking Payment Initiation Service Periodic Payment Initiation Service (Extended service) API
  description: '### Introduction

    There are several flows (sequence of API calls) to complete a payment. Which

    API''s are required depend on the choosen `PaymentProduct`, ASPSP (debtor bank) and the chosen strong customer

    authentication approach. The response of an API call will indicate in the ''Links'' section which next

    API call is required to complete the payment. Both PSD2 and IDEAL payments are supported.


    #### PSD2 Sandbox

    Several AspspId''s are available to test specific PSD2 payment initiation scenario''s, see sandbox documentation.


    The following authorization token can be used to test in the sandbox (unlike a real token this one doesn''t expire):

    **97fb13a74c712d8c7a50476e71769eaf**

    '
  version: 3.15.0
servers:
- url: https://xs2a.awltest.de/xs2a/routingservice/services/ob/pis/v3
  description: PSD2 Sandbox
- url: https://digitalroutingservice.awltest.de/xs2a/routingservice/services/ob/pis/v3
  description: iDEAL Sandbox
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:
  schemas:
    PaymentIdentificationRequest:
      type: object
      additionalProperties: false
      properties:
        PsuData:
          $ref: '#/components/schemas/PsuDataIdentification'
    RemittanceInformationStructured:
      required:
      - Reference
      type: object
      additionalProperties: false
      properties:
        Reference:
          type: string
          pattern: '[a-zA-Z0-9]{1,35}'
          description: 'The actual reference.

            '
        ReferenceType:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Reference type.

            '
        ReferenceIssuer:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Identification of the issuer of the ReferenceType.

            '
    ScaMethods:
      required:
      - AuthenticationMethodId
      - AuthenticationType
      type: object
      additionalProperties: false
      properties:
        AuthenticationType:
          type: string
          description: 'Type of the SCA authentication method. The following methods are commonly seen coming from the ASPSP:

            -  SMS_OTP: The PSU will receive a One Time Password via SMS

            -  CHIP_OTP: The PSU will be presented with a picture or text to create a One Time Password using their bank card

            -  PHOTO_OTP: The PSU will be presented with a picture to create a One Time Password

            -  PUSH_OTP: The PSU will receive a One Time Password via push notification on their mobile device

            -  SMTP_OTP: The PSU will receive a One Time Password via email

            '
        AuthenticationMethodId:
          minLength: 1
          type: string
          description: 'Id of the authentication method. Used in subsequent API calls to refer to the authentication method.

            '
        Version:
          minLength: 1
          type: string
          description: 'Version of the method.

            '
        Name:
          minLength: 1
          type: string
          description: 'Name of the method in readable form. This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.

            '
        Explanation:
          minLength: 1
          type: string
          description: 'Detailed information about the SCA method, meant for the PSU.

            '
    AddressData:
      type: object
      additionalProperties: false
      properties:
        FirstName:
          type: string
          description: 'The first name of the debtor

            '
          example: Bob
          minLength: 1
        LastName:
          type: string
          description: 'The last name of the debtor

            '
          example: Smith
          minLength: 1
        CompanyName:
          type: string
          description: 'The company name of the debtor

            '
          example: Cookie factory
          minLength: 1
        PostCode:
          type: string
          description: 'The postal code of the address without spaces

            '
          example: 1234AB
          minLength: 1
        BuildingNumber:
          type: string
          description: 'The house number of the address

            '
          example: '100'
          minLength: 1
        Floor:
          type: string
          description: 'The addition of the address

            '
          example: 3B
          minLength: 1
        StreetName:
          type: string
          description: 'The street of the address

            '
          example: Coolsingel
          minLength: 1
        TownName:
          type: string
          description: 'The city of the address

            '
          example: Rotterdam
          minLength: 1
        Country:
          type: string
          description: 'The code of the coutry regarding ISO 3166 standard. For the IDEAL payments the country name will be provided

            '
          minLength: 1
        CountrySubDivision:
          type: string
          description: 'Country sub division.

            '
          maxLength: 35
          minLength: 1
    CommonPaymentDataIdentificationResponse:
      type: object
      additionalProperties: false
      required:
      - PaymentId
      - PaymentStatus
      properties:
        PaymentId:
          maxLength: 35
          minLength: 1
          type: string
          description: 'Id generated by the Open Banking Service. This should be used to

            refer to this payment in subsequent api calls.

            '
        PaymentStatus:
          $ref: '#/components/schemas/PaymentStatusEnum'
        AuthStatus:
          $ref: '#/components/schemas/AuthStatusEnum'
        PsuMessage:
          maxLength: 1024
          minLength: 1
          type: string
          description: 'Text to be displayed to the PSU.

            '
    RegulatoryReportingCode:
      maxLength: 10
      type: string
      description: 'Information needed due to regulatory and statutory requirements.

        Economical codes to be used are provided by the National Competent Authority

        '
      x-DefinitionType: ISO20022
    DebtorAccount:
      required:
      - Identification
      type: object
      additionalProperties: false
      properties:
        SchemeName:
          $ref: '#/components/schemas/IdentificationTypeEnum'
        Identification:
          type: string
          description: 'Unambiguous identification of the account of the debtor to

            which a debit entry will be made as a result of the transaction.

            '
        SecondaryIdentification:
          type: string
          description: 'Secondary identification of the Debtor Account, to which a

            debit entry will be made as a result of the transaction. (Only Openbank

            UK)

            '
        Currency:
          pattern: '[A-Z]{3,3}'
          type: string
          description: 'A code allocated to a currency by a Maintenance Agency under

            an international identification scheme, as described in the latest edition

            of the international standard ISO 4217 "Codes for the representation of

            currencies and funds".

            '
    PsuCredentials:
      required:
      - CredentialsDetails
      type: object
      additionalProperties: false
      properties:
        AspspProductCode:
          type: string
          description: 'Product Identification. Used to contextualize the credentials

            provided by the PSU for those ASPSP that need of it.

            '
        CredentialsDetails:
          type: array
          description: Credentials Details
          items:
            $ref: '#/components/schemas/CredentialDetails'
      description: 'PSU Credentials on the Bank system.

        '
    CredentialDetails:
      required:
      - CredentialId
      - IsSecret
      - LabelList
      type: object
      additionalProperties: false
      properties:
        IsSecret:
          type: boolean
          description: 'Binary identification of the transparancy of the provided

            credentials by the PSU. Can have 2 values,

            * true

            * false


            Can be provided by ASPSP. If not provided by the

            ASPSP then by default,

            * true, if the CredentialId=ewl-password

            * false, if CredentialId=ewl-user-id

            '
        CredentialId:
          type: string
          description: 'Credential detail identification of the PSU credential at the

            bank (provided bi CBI if approach is Embedded). If not provided

            by the ASPSP, then default values should be,

            * ewl-user-id, when IsSecret=false

            * ewl-password, when IsSecret=true

            '
        LabelList:
          type: array
          description: 'The list of the labels to show to the PSU. They are

            internationalized.

            '
          items:
            $ref: '#/components/schemas/CredentialLabel'
      description: 'Credentials Details.

        '
    AuthorisationResponseLinks:
      type: object
      additionalProperties: false
      description: 'A list of hyperlinks to be recognized by the Initiating Party. The actual

        hyperlinks used in the response depend on the dynamical decisions on

        authorization approach for example. Remark - All links are full links.

        * ''RedirectUrl'': In case of an Redirect approach, the Initiating Party has to use this link to redirect the PSU’s browser session.

        * ''PutAuthorisationForEmbedded'': In case of an embedded approach, endpoint to be called to start the embedded authorization.

        * ''SelectAuthenticationMethod'': In case of an embedded approach, the Initiating Party has to use this link to pass the SCA method.

        * ''AuthorizeTransaction'': In case of an embedded approach, the Initiating Party has to authorize the payment by providing the SCA OneTimePassword.

        * ''ConfirmationRequired'': Endpoint to be called for payment confirmation for ASPSPs that require explicit confirmation of payments.

        * ''GetPaymentStatus'': Endpoint to be called for retrieving the payment status.

        '
      properties:
        RedirectUrl:
          $ref: '#/components/schemas/Link'
        PutAuthorisationForEmbedded:
          $ref: '#/components/schemas/Link'
        SelectAuthenticationMethod:
          $ref: '#/components/schemas/Link'
        AuthorizeTransaction:
          $ref: '#/components/schemas/Link'
        ConfirmationRequired:
          $ref: '#/components/schemas/Link'
        GetPaymentStatus:
          $ref: '#/components/schemas/Link'
    CreditorDateAndPlaceOfBirth:
      required:
      - BirthDate
      - CityOfBirth
      - CountryOfBirth
      type: object
      additionalProperties: false
      properties:
        BirthDate:
          type: string
          description: Date on which a person is born.
          format: date
        CityOfBirth:
          maxLength: 35
          type: string
          description: City where a person was born.
        CountryOfBirth:
          pattern: ^[A-Z]{2,2}$
          type: string
          description: Country where a person was born.
      description: 'Date and place of birth of a person.

        This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

        '
      x-DefinitionType: ISO20022
    PaymentCancellationResponse:


# --- truncated at 32 KB (94 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