---
swagger: "2.0"
info:
  version: 1.0.11
  title: PSD2 PIIS
  description: This set of methods involves the implementation of a PSD2 compliant
    API based on Berlin Group XS2A Framework.
  contact:
    name: Piraeus Bank rAPIdLink
    url: https://rapidlink.piraeusbank.gr
    email: rapidlink@piraeusbank.gr
  x-ibm-name: psd2-piis
  termsOfService: <href a="https://rapidlink.piraeusbank.gr/terms">Terms and Conditions</href>
  license:
    name: Terms and Conditions of Use
    url: https://rapidlink.piraeusbank.gr/terms
basePath: /psd2/piis
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
  /v1/funds-confirmations:
    post:
      description: Creates a confirmation of funds request to check whether a specific
        amount is available at the time of the request on an account linked to a given
        tuple card issuer (TPP)/card number, or addressed by IBAN and TPP respectively
      summary: checkAvailabilityOfFunds
      tags:
      - Confirmation of Funds Service (PIIS)
      operationId: V1FundsConfirmationsPost
      deprecated: false
      produces:
      - application/json
      parameters:
      - name: X-Request-ID
        in: header
        required: true
        type: string
        format: uuid
        description: ID of the request, unique to the call, as determined by the initiating
          party.
      - name: body
        in: body
        required: true
        description: Request body for a confirmation of funds request.
        schema:
          $ref: '#/definitions/confirmationOfFunds'
      - name: Consent-ID
        in: header
        required: false
        type: string
        description: |-
          This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service.
          This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
      - name: Digest
        in: header
        required: false
        type: string
        description: Is contained if and only if the "Signature" element is contained
          in the header of the request.
      - name: Signature
        in: header
        required: false
        type: string
        description: A signature of the request by the TPP on application level. This
          might be mandated by ASPSP.
      - name: TPP-Signature-Certificate
        in: header
        required: false
        type: string
        description: |-
          The certificate used for signing the request, in base64 encoding.
          Must be contained if a signature is contained.
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/V1FundsConfirmationsResponse'
          headers:
            Location:
              type: string
            X-Request-ID:
              type: string
              default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/Error400_NG_PIIS'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error401_NG_PIIS'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/Error403_NG_PIIS'
        404:
          description: Not found
          schema:
            $ref: '#/definitions/Error404_NG_PIIS'
        405:
          description: Method Not Allowed
          schema:
            $ref: '#/definitions/Error405_NG_PIIS'
        406:
          description: Not Acceptable
        408:
          description: Request Timeout
        409:
          description: Conflict
          schema:
            $ref: '#/definitions/Error409_NG_PIIS'
        415:
          description: Unsupported Media Type
        429:
          description: Too Many Requests
        503:
          description: Service Unavailable
        default:
          description: Internal Server Error
    parameters:
    - $ref: '#/parameters/Authorization'
    - $ref: '#/parameters/X-IBM-Client-Id'
definitions:
  accountReference:
    description: |-
      Reference to an account by either:
        - IBAN, of a payment accounts, or
        - BBAN, for payment accounts if there is no IBAN, or
        - the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
        - the Primary Account Number (PAN) of a card in a masked form, or
        - an alias to access a payment account via a registered mobile phone number (MSISDN).
    type: object
    properties:
      iban:
        description: IBAN of an account
        example: FR7612345987650123456789014
        type: string
        pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
      bban:
        description: |-
          Basic Bank Account Number (BBAN) Identifier

          This data element can be used in the body of the Consent Request
            Message for retrieving Account access Consent from this Account. This
            data elements is used for payment Accounts which have no IBAN.
            ISO20022: Basic Bank Account Number (BBAN).

            Identifier used nationally by financial institutions, i.e., in individual countries,
            generally as part of a National Account Numbering Scheme(s),
            which uniquely identifies the account of a customer.
        example: BARC12345612345678
        type: string
        pattern: '[a-zA-Z0-9]{1,30}'
      pan:
        description: Primary Account Number according to ISO/IEC 7812.
        example: 5409050000000000
        type: string
        maxLength: 35
      maskedPan:
        description: Masked Primary Account Number
        example: 123456xxxxxx1234
        type: string
        maxLength: 35
      msisdn:
        description: Mobile phone number.
        example: +49 170 1234567
        type: string
        maxLength: 35
      currency:
        description: ISO 4217 Alpha 3 currency code
        example: EUR
        type: string
        pattern: '[A-Z]{3}'
  hrefType:
    description: Link to a resource
    type: object
    properties:
      href:
        description: Link to a resource
        example: /v1/payments/sepa-credit-transfers/1234-wertiq-983
        type: string
  amount:
    example:
      currency: EUR
      amount: 123
    type: object
    properties:
      currency:
        description: ISO 4217 Alpha 3 currency code
        example: EUR
        type: string
        pattern: '[A-Z]{3}'
      amount:
        description: |-
          The amount given with fractional digits, where fractions must be compliant to the currency definition.
          Up to 14 significant figures. Negative amounts are signed by minus.
          The decimal separator is a dot.

          **Example:**
          Valid representations for EUR with up to two decimals are:

            * 1056
            * 5768.2
            * -1.50
            * 5877.78
        example: 5877.780000
        type: string
        pattern: -?[0-9]{1,14}(\.[0-9]{1,3})?
    required:
    - currency
    - amount
    description: Object describing an amount as a combination of its value and currency
      code
  confirmationOfFunds:
    description: JSON Request body for the "Confirmation of Funds Service"
    type: object
    properties:
      cardNumber:
        description: |-
          Card Number of the card issued by the PIISP.
          Should be delivered if available.
        type: string
        maxLength: 35
      account:
        $ref: '#/definitions/accountReference'
      payee:
        description: Name payee
        type: string
        maxLength: 70
      instructedAmount:
        $ref: '#/definitions/amount'
    required:
    - account
    - instructedAmount
  _linksAll:
    description: A _link object with all available link types
    type: object
    properties:
      scaRedirect:
        $ref: '#/definitions/hrefType'
      scaOAuth:
        $ref: '#/definitions/hrefType'
      startAuthorisation:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithPsuIdentification:
        $ref: '#/definitions/hrefType'
      updatePsuIdentification:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithProprietaryData:
        $ref: '#/definitions/hrefType'
      updateProprietaryData:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithPsuAuthentication:
        $ref: '#/definitions/hrefType'
      updatePsuAuthentication:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithEncryptedPsuAuthentication:
        $ref: '#/definitions/hrefType'
      updateEncryptedPsuAuthentication:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithAuthenticationMethodSelection:
        $ref: '#/definitions/hrefType'
      selectAuthenticationMethod:
        $ref: '#/definitions/hrefType'
      startAuthorisationWithTransactionAuthorisation:
        $ref: '#/definitions/hrefType'
      authoriseTransaction:
        $ref: '#/definitions/hrefType'
      self:
        $ref: '#/definitions/hrefType'
      status:
        $ref: '#/definitions/hrefType'
      scaStatus:
        $ref: '#/definitions/hrefType'
      account:
        $ref: '#/definitions/hrefType'
      balances:
        $ref: '#/definitions/hrefType'
      transactions:
        $ref: '#/definitions/hrefType'
      transactionDetails:
        $ref: '#/definitions/hrefType'
      cardAccount:
        $ref: '#/definitions/hrefType'
      cardTransactions:
        $ref: '#/definitions/hrefType'
      first:
        $ref: '#/definitions/hrefType'
      next:
        $ref: '#/definitions/hrefType'
      previous:
        $ref: '#/definitions/hrefType'
      last:
        $ref: '#/definitions/hrefType'
      download:
        $ref: '#/definitions/hrefType'
  tppMessageCategory:
    description: Category of the TPP message
    example: ERROR
    type: string
    enum:
    - ERROR
    - WARNING
  MessageCode2XX:
    description: Message codes for HTTP Error codes 2XX.
    example: WARNING
    type: string
    enum:
    - WARNING
  MessageCode400_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
    example: FORMAT_ERROR
    type: string
    enum:
    - FORMAT_ERROR
    - PARAMETER_NOT_CONSISTENT
    - PARAMETER_NOT_SUPPORTED
    - SERVICE_INVALID
    - RESOURCE_UNKNOWN
    - RESOURCE_EXPIRED
    - RESOURCE_BLOCKED
    - TIMESTAMP_INVALID
    - PERIOD_INVALID
    - SCA_METHOD_UNKNOWN
    - CONSENT_UNKNOWN
    - CARD_INVALID
    - NO_PIIS_ACTIVATION
  MessageCode401_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
    example: CERTIFICATE_INVALID
    type: string
    enum:
    - CERTIFICATE_INVALID
    - CERTIFICATE_EXPIRED
    - CERTIFICATE_BLOCKED
    - CERTIFICATE_REVOKE
    - CERTIFICATE_MISSING
    - SIGNATURE_INVALID
    - SIGNATURE_MISSING
    - CORPORATE_ID_INVALID
    - PSU_CREDENTIALS_INVALID
    - CONSENT_INVALID
    - CONSENT_EXPIRED
    - TOKEN_UNKNOWN
    - TOKEN_INVALID
    - TOKEN_EXPIRED
  MessageCode403_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
    example: CONSENT_UNKNOWN
    type: string
    enum:
    - CONSENT_UNKNOWN
    - SERVICE_BLOCKED
    - RESOURCE_UNKNOWN
    - RESOURCE_EXPIRED
  MessageCode404_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
    example: RESOURCE_UNKNOWN
    type: string
    enum:
    - RESOURCE_UNKNOWN
  MessageCode405_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT
      ALLOWED).
    example: SERVICE_INVALID
    type: string
    enum:
    - SERVICE_INVALID
  MessageCode409_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
    example: STATUS_INVALID
    type: string
    enum:
    - STATUS_INVALID
  MessageCode415_PIIS:
    description: Message codes defined for PIIS for HTTP Error code 415 (UNSUPPORTED
      MEDIA TYPE).
    example: UNSUPPORTED_MEDIA_TYPE
    type: string
    enum:
    - UNSUPPORTED_MEDIA_TYPE
  MessageCode503_PIIS:
    description: Message codes for HTTP Error code 503 (SERVICE UNAVAILABLE).
    example: SERVICE_UNAVAILABLE
    type: string
    enum:
    - SERVICE_UNAVAILABLE
  tppMessage2XX:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        description: Message codes for HTTP Error codes 2XX.
        example: WARNING
        type: string
        default: WARNING
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage400_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        $ref: '#/definitions/MessageCode400_PIIS'
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage401_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        $ref: '#/definitions/MessageCode401_PIIS'
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage403_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        $ref: '#/definitions/MessageCode403_PIIS'
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage404_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        description: Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
        example: RESOURCE_UNKNOWN
        type: string
        default: RESOURCE_UNKNOWN
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage405_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        description: Message codes defined for PIIS for HTTP Error code 405 (METHOD
          NOT ALLOWED).
        example: SERVICE_INVALID
        type: string
        default: SERVICE_INVALID
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage409_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        description: Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
        example: STATUS_INVALID
        type: string
        default: STATUS_INVALID
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage415_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        $ref: '#/definitions/MessageCode415_PIIS'
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  tppMessage503_PIIS:
    type: object
    properties:
      category:
        $ref: '#/definitions/tppMessageCategory'
      code:
        $ref: '#/definitions/MessageCode503_PIIS'
      path:
        type: string
      text:
        description: Additional explaining text to the TPP.
        type: string
        maxLength: 512
    required:
    - category
    - code
  Error400_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 400 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode400_PIIS'
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError2'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error401_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 401 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode401_PIIS'
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError6'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error403_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 403 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode403_PIIS'
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError10'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error404_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 404 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
        example: RESOURCE_UNKNOWN
        type: string
        default: RESOURCE_UNKNOWN
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError14'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error405_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 405 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 405 (METHOD
          NOT ALLOWED).
        example: SERVICE_INVALID
        type: string
        default: SERVICE_INVALID
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError19'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error409_PIIS:
    description: |-
      Standardised definition of reporting error information according to [RFC7807]
      in case of a HTTP error code 409 for PIIS.
    type: object
    properties:
      type:
        description: |-
          A URI reference [RFC3986] that identifies the problem type.
          Remark For Future: These URI will be provided by NextGenPSD2 in future.
        type: string
        maxLength: 70
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
        example: STATUS_INVALID
        type: string
        default: STATUS_INVALID
      additionalErrors:
        description: |-
          Array of Error Information Blocks.

          Might be used if more than one error is to be communicated
        type: array
        items:
          $ref: '#/definitions/AdditionalError24'
      _links:
        $ref: '#/definitions/_linksAll'
    required:
    - type
    - code
  Error400_NG_PIIS:
    description: NextGenPSD2 specific definition of reporting error information in
      case of a HTTP error code 400.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage400_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error401_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage401_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error403_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage403_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error404_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage404_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error405_NG_PIIS:
    description: NextGenPSD2 specific definition of reporting error information in
      case of a HTTP error code 405.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage405_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error409_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage409_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error415_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 415.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage415_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  Error503_NG_PIIS:
    description: |
      NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 503.
    type: object
    properties:
      tppMessages:
        type: array
        items:
          $ref: '#/definitions/tppMessage503_PIIS'
      _links:
        $ref: '#/definitions/_linksAll'
  AdditionalError2:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode400_PIIS'
    required:
    - code
  AdditionalError6:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode401_PIIS'
    required:
    - code
  AdditionalError10:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        $ref: '#/definitions/MessageCode403_PIIS'
    required:
    - code
  AdditionalError14:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
        example: RESOURCE_UNKNOWN
        default: RESOURCE_UNKNOWN
        $ref: '#/definitions/MessageCode404_PIIS'
    required:
    - code
  AdditionalError19:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 405 (METHOD
          NOT ALLOWED).
        example: SERVICE_INVALID
        default: SERVICE_INVALID
        $ref: '#/definitions/MessageCode405_PIIS'
    required:
    - code
  AdditionalError24:
    description: This is a data element to support the declaration of additional errors
      in the context of [RFC7807].
    type: object
    properties:
      title:
        description: |-
          Short human readable description of error type.
          Could be in local language.
          To be provided by ASPSPs.
        type: string
        maxLength: 70
      detail:
        description: |-
          Detailed human readable text specific to this instance of the error.
          XPath might be used to point to the issue generating the error in addition.
          Remark for Future: In future, a dedicated field might be introduced for the XPath.
        type: string
        maxLength: 512
      code:
        description: Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
        example: STATUS_INVALID
        default: STATUS_INVALID
        $ref: '#/definitions/MessageCode409_PIIS'
    required:
    - code
  V1FundsConfirmationsResponse:
    description: Object containing a flag which determines whether the available funds
      are sufficient compared to the instructed amount provided in the request.
    type: object
    properties:
      fundsAvailable:
        type: boolean
        description: Equals "true" if sufficient funds are available at the time of
          the request, "false" otherwise.
    required:
    - fundsAvailable
tags:
- name: Confirmation of Funds Service (PIIS)
  description: Confirmation of Funds Service (PIIS) returns a confirmation of funds
    as per the TPP's request.
- name: Common Services
  description: Processes on starting authorisations, PSU authentication data and explicit
    authorisation of transactions via SCA, which are very similar among PIS and AIS.
    The API calls supporting these processes are described independently from the
    service/endpoint. For reasons of clarity, the endpoints are defined always for
    the Payment Initiation Service, the Payment Cancellation and the Account Information
    Service (Consents) separately. These processes are usually used following a hyperlink
    of the bank.
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  Sandbox OAuth:
    type: oauth2
    description: Resource Owner Implicit Grant Type
    flow: accessCode
    scopes:
      sandboxapi: Access to all Assets resources
      offline_access: Required for refresh tokens
    authorizationUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v2.1/oauth/oauth2/authorize
    tokenUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v2.1/oauth/oauth2/token
    x-tokenIntrospect:
      url: https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/v2.1/oauth/internal/introspect
  MSIS OAuth:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      winbankAccess winbankAccess.info: ""
      offline_access: Required for refresh tokens
    authorizationUrl: https://openbank.piraeusbank.gr/identityserver/connect/authorize
    x-tokenIntrospect:
      url: https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/v2.1/oauth/external/introspect
    tokenUrl: https://openbank.piraeusbank.gr/identityserver/connect/token
  clientIdHeader:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- MSIS OAuth:
  - winbankAccess winbankAccess.info
  clientIdHeader: []
- Sandbox OAuth:
  - sandboxapi
  clientIdHeader: []
externalDocs:
  description: 'For more information on the framework, please visit:'
  url: https://www.berlin-group.org/nextgenpsd2-downloads
parameters:
  Authorization:
    name: Authorization
    type: string
    required: true
    in: header
    description: This header should be in the form "Bearer Token", where Token is
      returned from the call to OAuth2.
  X-IBM-Client-Id:
    name: X-IBM-Client-Id
    type: string
    required: true
    in: header
    description: Application's client id
x-ibm-endpoints:
- endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production
  description: Base Gateway API Endpoint
  type:
  - production
  - development
...