Worldline

Worldline Payment Initiation Service API

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

Documentation GitHub OpenAPI

Operations 11

POST /payments Payment initiation request #

GET /payments/{paymentId}/status Retrieve payment status (in combination with status notifications) #

POST /payments/{paymentId}/confirmation Confirmation of the payment request by the PISP #

POST /payments/{paymentId}/identification Payment identification request #

GET /payments/{paymentId}/qrcode Retrieve QR code

POST /payments/{paymentId}/authorisations Payment authorisation request #

PUT /payments/{paymentId}/authorisations/{authorisationId} Payment authorisation request #

DELETE /payments/{paymentId} Payment cancellation request #

POST /payments/{paymentId}/cancellation-identification Payment cancellation identification request #

POST /payments/{paymentId}/cancellation-authorisations Payment cancellation authorisation request #

PUT /payments/{paymentId}/cancellation-authorisations/{authorisationId} Payment cancellation authorisation request update #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-payment-initiation-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-payment-initiation-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

openapi: 3.2.0
info:
  title: Open Banking Payment Initiation 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: 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:
  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.

            '
    PaymentInitiationRequest:
      type: object
      additionalProperties: false
      description: 'Payment Initiation Request

        '
      required:
      - CommonPaymentData
      properties:
        PaymentProduct:
          type: array
          description: 'Multiple PaymentProducts can only be supplied if `UseAuthorisationLandingPages` equals `TRUE`. These will then influence ASPSPs visible to the PSU on the Bank Selection Interface.

            The IDEAL payment product cannot be mixed with the other PSD2-xxxx payment products, because it requires a separate subscription and therefore uses a different authorization token.

            '
          items:
            $ref: '#/components/schemas/PaymentProductEnum'
        PaymentProductChangeable:
          type: boolean
          default: false
          description: 'Allowing PSU to change pre-selected payment product if the ASPSP supports more than one from the list provided by the Initiating Party. Usable only if `UseAuthorisationLandingPages` equals `TRUE`. Otherwise will be ignored.

            '
        ProductSpecificMasterData:
          type: array
          description: 'The array is defined to mention the master data specific to selected payment product

            '
          items:
            $ref: '#/components/schemas/ProductSpecificMasterData'
        PsuData:
          $ref: '#/components/schemas/PsuData'
        CommonPaymentData:
          $ref: '#/components/schemas/PaymentInitiationRequestBasic'
        IDEALPayments:
          $ref: '#/components/schemas/IDEALPayments'
    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
          descr

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