Worldline Refund Initiation Service V3 (Extended services) API

openapi: 3.2.0
info:
  title: Open Banking Payment Initiation Service Refund Initiation Service V3 (Extended services) 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: Refund Initiation Service V3 (Extended services)
paths:
  /refunds:
    post:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Refund initiation request
      description: 'Use this operation to initiate one or more refunds. For Wero refunds only one refund may be provide with each request.

        '
      operationId: refundInitiate
      parameters:
      - $ref: '#/components/parameters/confirmForNotification'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/InitiatingPartyReturnUrl'
      - $ref: '#/components/parameters/InitiatingPartyRefundNotificationUrl'
      - $ref: '#/components/parameters/UseAuthorisationLandingPages'
      - $ref: '#/components/parameters/Locale'
      - $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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundInitiationRequest'
        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'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundInitiationResponse'
        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'
  /refunds/{refundId}/status:
    get:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Status of the refund
      description: 'Use this operation to retrieve the status of a refund.

        '
      operationId: refundStatus
      parameters:
      - $ref: '#/components/parameters/refundId'
      - $ref: '#/components/parameters/confirm'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/PsuIpAddress'
      responses:
        200:
          description: 'Successful

            '
          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/RefundStatusResponse'
        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'
  /refunds/{refundId}/confirmation:
    post:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Confirmation of the refund request by the PISP
      description: 'This API is used to confirm a refund, confirmation is required

        when the link ''ConfirmationRequired'' is returned.

        '
      operationId: refundConfirmation
      parameters:
      - $ref: '#/components/parameters/refundId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      - $ref: '#/components/parameters/InitiatingPartyReturnUrl'
      - $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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmationRequest'
        required: false
      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/RefundConfirmationResponse'
        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'
  /refunds/{refundId}/identification:
    post:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Refund identification request
      description: 'Use this operation to identify a PSU in decoupled approach. The

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

        field if this step is required.

        '
      operationId: refundIdentification
      parameters:
      - $ref: '#/components/parameters/refundId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentIdentificationRequest'
      responses:
        201:
          description: 'Created

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundIdentificationResponse'
        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'
  /refunds/{refundId}/authorisations:
    post:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Refund authorisation request
      description: 'Use this operation to authorise a refund explicitly.

        '
      operationId: refundAuthorisation
      parameters:
      - $ref: '#/components/parameters/refundId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        description: 'Description of request.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationRequest'
        required: false
      responses:
        201:
          description: 'Created

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundAuthorisationResponse'
        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'
  /refunds/{refundId}/authorisations/{authorisationId}:
    put:
      security:
      - Authorization: []
      tags:
      - Refund Initiation Service V3 (Extended services)
      summary: Refund authorisation request
      description: 'Use this operation to change the authorisation resource.

        '
      operationId: refundAuthorisationUpdate
      parameters:
      - $ref: '#/components/parameters/refundId'
      - $ref: '#/components/parameters/authorisationId'
      - $ref: '#/components/parameters/X-Request-ID'
      - $ref: '#/components/parameters/MessageCreateDateTime'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAuthorisationUpdateRequest'
        required: false
      responses:
        200:
          description: 'Updated

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
            MessageCreateDateTime:
              $ref: '#/components/headers/MessageCreateDateTime'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundAuthorisationResponse'
        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'
    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.

            '
    RefundStatusResponse:
      required:
      - CommonPaymentData
      type: object
      additionalProperties: false
      properties:
        CommonPaymentData:
          $ref: '#/components/schemas/CommonPaymentDataRefundDetailsResponse'
        Links:
          $ref: '#/components/schemas/StatusResponseLinks'
    AuthStatusEnum:
      description: "This data element is containing information about the status of the SCA method applied.\n\nThe following codes are defined for this data type.\n\n  * 'Received':\n    An authorisation or cancellation-authorisation resource has been created successfully.\n  * 'PsuIdentified':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n  * 'PsuAuthenticated':\n    The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n  * 'ScaMethodSelected':\n    The PSU/TPP has selected the related SCA routine.\n    If the SCA method is chosen implicitly since only one SCA method is available,\n    then this is the first status to be reported instead of 'received'.\n  * 'Started':\n    The addressed SCA routine has been started.\n  * 'Finalised':\n    The SCA routine has been finalised successfully.\n  * 'Failed':\n    The SCA routine failed\n  * 'Exempted':\n    SCA was exempted for the related transaction, the related authorisation is successful.\n  * 'Unconfirmed':\n              SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet.\n"
      type: string
      enum:
      - Received
      - PsuIdentified
      - PsuAuthenticated
      - ScaMethodSelected
      - Started
      - Finalised
      - Failed
      - Exempted
      - Unconfirmed
    EstimatedTotalAmount:
      type: object
      additionalProperties: false
      required:
      - Currency
      - Amount
      properties:
        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".

            '
        Amount:
          pattern: ^\d{1,13}\.\d{1,2}$
          type: string
          description: 'Amount

            '
      description: 'Estimated Total Amount.

        '
    DebtorInformation:
      type: object
      additionalProperties: false
      description: 'All debtor relavant data

        '
      properties:
        Name:
          maxLength: 140
          type: string
          description: 'The name of the debtor.

            '
        Agent:
          type: string
          pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}'
          description: 'BIC of the financial institution servicing an account for

            the debtor.

            '
        Account:
          $ref: '#/components/schemas/DebtorAccount'
        UltimateDebtor:
          maxLength: 140
          type: string
          description: 'Ultimate party that owes an amount of money to the (ultimate)

            creditor.

            '
        ShippingAddress:
          $ref: '#/components/schemas/AddressData'
        BillingAddress:
          $ref: '#/components/schemas/BillingAddress'
    CredentialLabel:
      required:
      - Label
      - Language
      type: object
      additionalProperties: false
      properties:
        Label:
          type: string
          description: 'The label associated to the credentials to show to the PSU.

            '
        Language:
          type: string
          description: 'Label internationalization. It specifies the language of the

            label. The default value is EN

            '
    Link:
      required:
      - Href
      type: object
      additionalProperties: false
      properties:
        Href:
          maxLength: 1024
          minLength: 1
          type: string
    OverRefund:
      required:
      - Amount
      - Reason
      type: object
      additionalProperties: false
      properties:
        Amount:
          pattern: ^\d{1,13}\.\d{1,5}$
          type: string
          description: "Amount of the over refund. This field contains the amount that is refunded on top of a full refund. \nFor example, if a consumer orders goods for 100 euro, returns it, and receives a refund of 110EUR to cover shipping costs. \nThe decimal separator is a dot.\n"
          example: '10.00'
        Currency:
          pattern: '[A-Z]{3,3}'
          type: string
          description: 'Currency of the payment. ISO 4217 currency codes should be

            used.

            '
          example: EUR
          default: EUR
        Reason:
          type: string
          enum:
          - Goodwill
          - ReturnShippingCosts
          - MultipleSubscriptionRefund
          - AuxiliaryCostRefund
          - Other
          description: 'Reason of the over refund

            '
          example: Overrefund reason
    IdentificationTypeEnum:
      type: string
      description: 'Type of the account number.

        '
      enum:
      - IBAN
      - SortCodeAccountNumber
    PaymentStatusEnum:
      type: string
      description: 'Payment status.

        * ''TimeoutAtTpp'': This status can only occur in combination with the Bank Selection Interface (UseAuthorisationLandingPages = true). It''s set if the Bank Selection Interface concludes that the payment cannot be completed because of a timeout. It''s a final state.

        '
      enum:
      - Open
      - Authorised
      - PartiallyAuthorised
      - Pending
      - SettlementInProcess
      - SettlementCompleted
      - ReceivedByCreditorBank
      - ReceivedOnCreditorAccount
      - Cancelled
      - CancelledAtTPP
      - TimeoutAtTpp
      - Error
      - Expired
    RefundInitiationResponse:
      type: object
      additionalProperties: false
      required:
      - CommonPaymentData
      properties:
        CommonPaymentData:
          $ref: '#/components/schemas/CommonPaymentDataRefundResponse'
        Links:
          $ref: '#/components/schemas/RefundAuthorisationApproachLinks'
    RefundAmount:
      required:
      - Amount
      type: object
      additionalProperties: false
      properties:
        Amount:
          pattern: ^\d{1,13}\.\d{1,5}$
          type: string
          description: 'Amount of the payment. The decimal separator is a dot.

            '
          example: '123.45'
        Currency:
          pattern: '[A-Z]{3,3}'
          type: string
          description: 'Currency of the payment. ISO 4217 currency codes should be

            used.

            '
          example: EUR
          default: EUR
    TransactionFees:
      type: object
      additionalProperties: false
      properties:
        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".

            '
        Amount:
          pattern: ^\d{1,13}\.\d{1,5}$
          type: string
          description: 'Amount of the fees.

            '
        FeesApply:
          type: boolean
          default: false
          description: 'Indicates if transaction fees are applicable on the payment.

            '
      description: 'Information used for transporting transaction fees by the ASPSP.

        '
    PsuData:
      type: object
      additionalProperties: false
      properties:
        AspspId:
          minLength: 1
          type: string
          description: 'The Id of the ASPSP. The Open Banking Service needs this

            information for PSD2 payments to route the payment. It has to be either

            provided in this field or by the PSU in the Bank Selection Interface.

            '
        AspspProductCode:
          type: string
          description: 'This is describing the ProductCode as defined by the ASPSP.

            '
        AspspPsuId:
          type: string
          example: Psu-12345
          description: 'PSU’s Id at ASPSP. Allows the unique identification of the PSU at

            the ASPSP.

            '
        AspspCustomerId:
          type: string
          example: Psu-12345
          description: 'PSU’s second Id at ASPSP. Required for some ASPSPs

            '
        AspspPsuIdType:
          type: string
          description: 'Type of the ASPSP PSU-ID, needed in scenarios where PSU''s have

            several PSU-IDs as access possibility.

            '
        AspspPsuCorporateId:
          type: string
          description: 'Identification of a Corporate in the Online Channels.

            '
        AspspPsuCorporateIdType:
          type: string
          description: 'This is describing the type of the identification needed by the

            ASPSP to identify the PsuCorporate-ID content.

            '
        Country:
          type: string
          minLength: 2
          maxLength: 2
          pattern: '[A-Z]{2,2}'
          example: FR
          description: It is used to select a preferred country that is pre-selected on the bank selection page.
    AmountRelatedDetails:
      type: object
      additionalProperties: false
      description: 'contains additional information about the fees and estimated amount

        '
      properties:
        TransactionFees:
          $ref: '#/components/schemas/TransactionFees'
        ExchangeRateInformation:
          $ref: '#/components/schemas/ExchangeRateInformationResponse'
        CurrencyConversionFee:
          $ref: '#/components/schemas/CurrencyConversionFee'
        EstimatedTotalAmount:
          $ref: '#/components/schemas/EstimatedTotalAmount'
        EstimatedInterbankSettlementAmount:
          $ref: '#/components/schemas/EstimatedInterbankSettlementAmount'
    CommonPaymentDataRefundAuthorisationResponse:
      type: object
      additionalProperties: false
      required:
      - RefundId
      - RefundStatus
      properties:
        RefundId:
          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.

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

            '
    AccountError:
      type: object
      additionalProperties: false
      required:
      - PaymentId
      - Error
      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.

            '
        Error:
          required:
          - Code
          - Message
          type: object
          additionalProperties: false
          properties:
            Code:
              pattern: '[0-9]{1,3}'
              type: string
            Message:
              maxLength: 140
              minLength: 1
              type: string
          description: '|Code |Description

            |-----|---------------------------------------

            |001  |The payment is not authorized.

            |002  |The payment is not confirmed.

            |003  |The refund amount is above the payment amount or the remaning payment amount.

            |004  |The creditor account does not match the initial payment debtor account.

            |005  |No existing payment found for the paymentId you provided.

            |006  |Both Identification and SchemeName fields are mandatory for the CreditorAccount.

            |007  |The refund currency does not match the initial payment currency.

            |008  |The payment id is missing.

            |009  |The refund amount is missing.

            |010  |The refund currency is missing.

            |011  |The Creditor Account is missing.

            '
    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
    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".

            '
    StatusResponseLinks:
      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.

        * ''PostAuthorisationForExplicit'': In case the ASPSP requires explicit start of authorization.

        * ''PostIdentificationForDecoupled'': In case of a Decoupled approach, identification of the PSU required to start the decoupled authorization.

        * ''PutAuthorisationForEmbedded'': In case of an embedded approach, endpoint to be called to add information to the 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.

        '
      properties:
        RedirectUrl:
          $ref: '#/components/schemas/Link'
        PostAuthorisationForExplicit:
          $ref: '#/components/schemas/Link'
        PostIdentificationForDecoupled:
          $ref: '#/components/schemas/Link'
        PostAuthorisationForEmbedded:
          $ref: '#/components/schemas/Link'
        PutAuthorisationForEmbedded:
          $ref: '#/components/schemas/Link'
        SelectAuthenticationMethod:
          $ref: '#/components/schemas/Link'
        AuthorizeTransaction:
          $ref: '#/components/schemas/Link'
        ConfirmationRequired:
          $ref: '#/components/schemas/Link'
    CreditorAccount:
      type: object
      additionalProperties: false
      properties:
        SecondaryIdentification:
          type: string
          description: 'Secondary identification of the Creditor Account, to which

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

         

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