---
swagger: "2.0"
info:
  version: 2.1.7
  title: Account Information
  x-ibm-name: sibs-psd2-accounts-stub-api
  description: "Account Information API enables the access to account identification
    data, account balances and account transactions history.\n\nWith this type of
    information you may provide to your users a consolidated view of his available
    balance, incomes and spending. Based on the transactions history you may understand
    the spending behavior of \nyour users, both private and corporate, predict overdrafts
    and warn or offer them a credit line from your partner credit institutions, reconcile
    invoices with payments for corporates, alert for the possibility \nof fraud when
    abnormal spends occur, etc.\n\nThis API intends to provide an interface to access
    PSD2 Account Information services.\n\nThe API is designed on a REST model using
    JSON structures.\n"
  contact:
    name: ""
    url: ""
  license:
    name: ""
    url: ""
basePath: /
schemes:
- https
produces:
- application/json
consumes:
- application/json
paths:
  /{aspsp-cde}/v1-0-2/accounts:
    get:
      operationId: readAccountList
      tags:
      - Read Account List
      summary: Read Account List
      description: Obtains the accounts covered by a consent.
      parameters:
      - $ref: '#/parameters/TPP-Transaction-ID'
      - $ref: '#/parameters/TPP-Request-ID'
      - $ref: '#/parameters/Consent-ID'
      - $ref: '#/parameters/Signature'
      - $ref: '#/parameters/Digest'
      - $ref: '#/parameters/TPP-Certificate'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/aspsp-cde'
      - $ref: '#/parameters/withBalance'
      - $ref: '#/parameters/psuInvolved'
      responses:
        200:
          description: OK
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/AccountsResponse'
        400:
          description: Bad Request.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gatewaty Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
  /{aspsp-cde}/v1-0-2/accounts/{account-id}:
    get:
      operationId: readAccountDetails
      tags:
      - Read Account Details
      summary: Read Account Details
      description: Obtains the properties of an account covered by a consent.
      parameters:
      - $ref: '#/parameters/TPP-Transaction-ID'
      - $ref: '#/parameters/TPP-Request-ID'
      - $ref: '#/parameters/Consent-ID'
      - $ref: '#/parameters/Signature'
      - $ref: '#/parameters/Digest'
      - $ref: '#/parameters/TPP-Certificate'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/aspsp-cde'
      - $ref: '#/parameters/account-id'
      - $ref: '#/parameters/withBalance'
      - $ref: '#/parameters/psuInvolved'
      responses:
        200:
          description: OK
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/AccountDetailResponse'
        400:
          description: Bad Request.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gatewaty Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
  /{aspsp-cde}/v1-0-2/accounts/{account-id}/balances:
    get:
      operationId: readBalance
      tags:
      - Read Balance
      summary: Read Balance
      description: Obtains the account balances
      parameters:
      - $ref: '#/parameters/TPP-Transaction-ID'
      - $ref: '#/parameters/TPP-Request-ID'
      - $ref: '#/parameters/Consent-ID'
      - $ref: '#/parameters/Signature'
      - $ref: '#/parameters/Digest'
      - $ref: '#/parameters/TPP-Certificate'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/aspsp-cde'
      - $ref: '#/parameters/account-id'
      - $ref: '#/parameters/psuInvolved'
      responses:
        200:
          description: OK
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/AccountBalancesResponse'
        400:
          description: Bad Request.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gatewaty Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
  /{aspsp-cde}/v1-0-2/accounts/{account-id}/transactions:
    get:
      operationId: readTransactionList
      tags:
      - Read Transaction List
      summary: Read Transaction List
      description: Obtains an account report.
      parameters:
      - $ref: '#/parameters/TPP-Transaction-ID'
      - $ref: '#/parameters/TPP-Request-ID'
      - $ref: '#/parameters/Consent-ID'
      - $ref: '#/parameters/Accept'
      - $ref: '#/parameters/Signature'
      - $ref: '#/parameters/Digest'
      - $ref: '#/parameters/TPP-Certificate'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/aspsp-cde'
      - $ref: '#/parameters/account-id'
      - $ref: '#/parameters/dateFrom'
      - $ref: '#/parameters/dateTo'
      - $ref: '#/parameters/transactionId'
      - $ref: '#/parameters/psuInvolved'
      - $ref: '#/parameters/bookingStatus'
      - $ref: '#/parameters/withBalance'
      - $ref: '#/parameters/deltaList'
      responses:
        200:
          description: OK
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/AccountTransactionResponse'
        400:
          description: Bad Request.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gatewaty Timeout.
          headers:
            Location:
              type: string
              description: Response Location.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
definitions:
  AccountBalancesResponse:
    type: object
    properties:
      balances:
        $ref: '#/definitions/BalanceArray'
        description: A list of balances regarding this account.
    additionalProperties: false
    description: Reads account data (balances) from a given account addressed by “account-id”.
  AccountDetail:
    description: detailed account information.
    type: object
    required:
    - iban
    properties:
      id:
        description: |
          This is the data element to be used in the path when retrieving data from a dedicated account.
        type: string
        maxLength: 35
        default: ""
      iban:
        description: International Bank Account Number
        type: string
        pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
        default: PT0000
      bban:
        description: 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
        type: string
        default: ""
      pan:
        description: Primary Account Number.
        type: string
        maxLength: 35
        default: ""
      maskedPan:
        description: Primary Account Number in a masked form.
        type: string
        maxLength: 35
        default: ""
      msisdn:
        description: An alias to access a payment account via a registered mobile
          phone number. This alias might be needed e.g. in the payment initiation
          service. The support of this alias must be explicitly documented by the
          ASPSP for the corresponding API Calls.
        type: string
        maxLength: 35
        default: ""
      currency:
        description: ISO 4217 Alpha 3 currency code.
        type: string
        default: ""
      name:
        description: Name of the account given by the bank or the PSU in Online-Banking.
        type: string
        maxLength: 35
        default: ""
      accountType:
        description: Product Name of the Bank for this account, proprietary definition.
        type: string
        maxLength: 35
        default: ""
      cashAccountType:
        description: ExternalCashAccountType1Code from ISO20022
        type: string
        default: ""
      bic:
        description: The BIC associated to the account.
        type: string
        default: ""
      balances:
        description: Account balances.
        items:
          $ref: '#/definitions/Balance'
        $ref: '#/definitions/BalanceArray'
      _links:
        description: |
          Links to the account, which can be directly used for retrieving account information from this dedicated account.


          Links to "balances" and/or "transactions".

          These links are only supported, when the corresponding consent has been already granted.
        $ref: '#/definitions/AccountLink'
    additionalProperties: false
  AccountDetailResponse:
    description: Reads details about an account, with balances where required.
    type: object
    properties:
      account:
        $ref: '#/definitions/AccountDetail'
        description: Properties of an Account.
    additionalProperties: false
  AccountLink:
    description: A link to the resource providing the details of one account.
    type: object
    properties:
      viewBalances:
        description: A link to the resource providing the balance of a dedicated account.
        type: string
        default: ""
      viewTransactions:
        type: string
        description: A link to the resource providing the transactions of a dedicated
          account.
        default: ""
    additionalProperties: false
  AccountReference:
    description: Identifier of the addressed account.
    type: object
    required:
    - iban
    properties:
      iban:
        description: International Bank Account Number.
        type: string
        pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
        default: PT0000
      bban:
        description: This data elements is used for payment accounts which have no
          IBAN.
        type: string
        default: ""
      pan:
        description: Primary Account Number (PAN) of a card, can be tokenised by the
          ASPSP due to PCI DSS requirements.
        type: string
        maxLength: 35
        default: ""
      maskedPan:
        description: Primary Account Number (PAN) of a card in a masked form.
        type: string
        maxLength: 35
        default: ""
      msisdn:
        description: An alias to access a payment account via a registered mobile
          phone number
        type: string
        maxLength: 35
        default: ""
      currency:
        description: ISO 4217 Alpha 3 currency code.
        type: string
        default: ""
    additionalProperties: false
  AccountReport:
    description: JSON based account report.
    type: object
    required:
    - booked
    properties:
      booked:
        description: Account booked transactions report.
        type: array
        items:
          $ref: '#/definitions/Transaction'
      pending:
        description: Account pending transactions report.
        type: array
        items:
          $ref: '#/definitions/Transaction'
      _links:
        $ref: '#/definitions/AccountReportLink'
        description: "The following links might be used within this context: \n- viewAccount
          (mandatory) \n- first (optional) \n- next (optional) \n- previous (optional)
          \n- last (optional) \n"
    additionalProperties: false
  AccountReportLink:
    description: List of Account Report Links
    type: object
    required:
    - viewAccount
    properties:
      viewAccount:
        description: A link to the resource providing the details of one account.
        type: string
        default: ""
      first:
        description: |
          Navigation link for paginated account reports.
        type: string
        default: ""
      next:
        description: |
          Navigation link for paginated account reports.
        type: string
        default: ""
      previous:
        description: |
          Navigation link for paginated account reports.
        type: string
        default: ""
      last:
        description: |
          Navigation link for paginated account reports.
        type: string
        default: ""
    additionalProperties: false
  AccountsResponse:
    description: Returns a list of bank accounts, with balances where required.
    type: object
    properties:
      accountList:
        items:
          description: detailed account information.
          $ref: '#/definitions/AccountDetail'
        description: List of detailed account information.
        $ref: '#/definitions/AccountDetailArray'
    additionalProperties: false
  AccountTransactionResponse:
    description: Reads account data (transactions) from a given account addressed
      by “account-id"
    type: object
    properties:
      transactions:
        description: JSON based account report.
        $ref: '#/definitions/AccountReport'
      _links:
        description: Report of Account Transactions.
        $ref: '#/definitions/TransactionLink'
    additionalProperties: false
  Amount:
    description: Transaction Instructed Amount.
    type: object
    required:
    - currency
    - content
    properties:
      currency:
        description: ISO 4217 Alpha 3 currency code.
        type: string
        pattern: ^[A-Z]{3,3}$
        default: AAA
      content:
        description: |
          The amount given with fractional digits, where fractions must be compliant to the currency definition.

          The decimal separator is a dot.
        type: string
        pattern: ^\-{0,1}[0-9]{1,9}(\.[0-9]{0,2}){0,1}$
        default: "0"
    additionalProperties: false
  AccountDetailArray:
    description: List of detailed account information.
    type: array
    items:
      $ref: '#/definitions/AccountDetail'
      description: Account Properties
    additionalProperties: false
  Balance:
    description: A balance regarding an account.
    type: object
    properties:
      closingBooked:
        description: |
          Balance of the account at the end of the pre-agreed account reporting period.      It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
        $ref: '#/definitions/SingleBalance'
      expected:
        description: |
          Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.
        $ref: '#/definitions/SingleBalance'
      authorised:
        description: |
          The expected balance together with the value of a pre-approved credit line the ASPSP makes permanently available to the user.
        $ref: '#/definitions/SingleBalance'
      openingBooked:
        description: |
          Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
        $ref: '#/definitions/SingleBalance'
      interimAvailable:
        description: |
          Available balance calculated in the course of the account ’servicer’s business day, at the time specified, and subject to further changes during the business day.  The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
        $ref: '#/definitions/SingleBalance'
    additionalProperties: false
  BalanceArray:
    description: A list of balances regarding an account.
    type: array
    items:
      $ref: '#/definitions/Balance'
      description: Single Balance
    additionalProperties: false
  ErrorMessage:
    description: Error Information.
    type: object
    properties:
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
  ErrorMessageWithStatus:
    description: Error and status Information.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: The transaction status is filled with codes of the ISO 20022
          corresponding element.
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
  MessageCode:
    description: Message error codes.
    type: string
    enum:
    - SERVICE_BLOCKED
    - CORPORATE_ID_IVALID
    - CONSENT_UNKNOWN
    - CONSENT_INVALID
    - CONSENT_EXPIRED
    - RESOURCE_UNIKNOWN
    - RESOURCE_EXPIRED
    - TIMESTAMP_INVALID
    - PERIOD_INVALID
    - SCA_METHOD_UNKKNOWN
    - TRANSACTION_ID_INVALID
    - PRODUCT_INVALID
    - PRODUCT_UNKNOWN
    - PAYMENT_FAILED
    - REQUIRED_KID_MISSING
    - SESSIONS_NOT_SUPPORTED
    - ACCESS_EXCEEDED
    - REQUESTED_FORMATS_INVALID
    - CARD_INVALID
    - NO_PIIS_ACTIVATION
    default: SERVICE_BLOCKED
    additionalProperties: false
  SingleBalance:
    description: Balance Properties.
    type: object
    required:
    - amount
    properties:
      amount:
        description: Balance Amount.
        $ref: '#/definitions/Amount'
      lastActionDateTime:
        description: |
          This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.
        type: string
        format: date-time
        default: "1900-01-01T00:00:00Z"
      date:
        description: Balance Date.
        type: string
        format: date
        default: "1900-01-01"
    additionalProperties: false
  TppMessage:
    required:
    - category
    - code
    description: Transports additional error information.
    properties:
      category:
        type: string
        default: ""
        description: Category of the error. Only "ERROR" or "WARNING" permitted.
      code:
        $ref: '#/definitions/MessageCode'
        description: Message error code.
      path:
        type: string
        default: ""
        description: Path of the element of the request message which provoked this
          error message.
      text:
        type: string
        maxLength: 512
        default: ""
        description: Additional explaining text.
    additionalProperties: false
  TppMessageArray:
    type: array
    description: Messages to the TPP on operational issues.
    items:
      $ref: '#/definitions/TppMessage'
      description: Transports additional error information.
    additionalProperties: false
  Transaction:
    type: object
    required:
    - amount
    description: Transaction Instructed Amount.
    properties:
      transactionId:
        description: |
          Can be used as access-ID in the API, where more details on an transaction is offered.
        type: string
        maxLength: 35
        default: ""
      endToEndId:
        description: Unique end to end identity.
        type: string
        maxLength: 35
        default: ""
      mandateId:
        description: |
          Identification of Mandates, e.g. a SEPA Mandate ID
        type: string
        maxLength: 35
        default: ""
      creditorId:
        description: |
          Identification of Creditors, e.g. a SEPA Creditor ID
        type: string
        maxLength: 35
        default: ""
      bookingDate:
        description: The Date when an entry is posted to an account on the ASPSP books.
        type: string
        format: date
        default: "1900-01-01"
      valueDate:
        description: The Date at which assets become available to the account owner
          in case of a credit
        type: string
        format: date
        default: "1900-01-01"
      amount:
        description: Transaction Instructed Amount.
        $ref: '#/definitions/Amount'
      creditorName:
        description: Name of the creditor if a “Debited” transaction
        type: string
        maxLength: 70
        default: ""
      creditorAccount:
        description: Creditor account identifier at a financial institution.
        $ref: '#/definitions/AccountReference'
      ultimateCreditor:
        description: Ultimate party to which an amount of money is due.
        type: string
        maxLength: 70
        default: ""
      debtorName:
        description: Name of the debtor if a “Credited” transaction
        type: string
        maxLength: 70
        default: ""
      debtorAccount:
        description: Identifier of the addressed account.
        $ref: '#/definitions/AccountReference'
      ultimateDebtor:
        description: Ultimate party that owes an amount of money to the (ultimate)
          creditor.
        type: string
        maxLength: 70
        default: ""
      remittanceInformationUnstructured:
        description: Remittance Information in an Unstructured Mode
        type: string
        maxLength: 140
        default: ""
      remittanceInformationStructured:
        description: Reference to be transported in the field.
        type: string
        maxLength: 140
        default: ""
      purposeCode:
        description: The underlying reason for the payment transaction.
        type: string
        default: ""
    additionalProperties: false
  TransactionLink:
    description: List of Transaction Report Links
    type: object
    properties:
      download:
        description: |
          Download link for huge AIS data packages.
        type: string
        default: ""
      first:
        type: string
        description: Navigation link for paginated transaction reports.
        default: ""
      next:
        description: Navigation link for paginated transaction reports.
        type: string
        default: ""
      previous:
        description: Navigation link for paginated transaction reports.
        type: string
        default: ""
      last:
        description: Navigation link for paginated transaction reports.
        type: string
        default: ""
    additionalProperties: false
  TransactionStatusType:
    description: |-
      ISO20022: The transaction status is filled with value of the ISO20022 data table.
      RCVD : RECEIVED
      PDNG : PENDING
      PATC : PARTIALLY ACCEPTED TECHNICAL CORRECT
      ACTC : ACCEPTED TECHNICAL VALIDATION
      RJCT : REJECTED
    type: string
    enum:
    - RCVD
    - PDNG
    - PATC
    - ACTC
    - RJCT
    default: RJCT
    additionalProperties: false
parameters:
  aspsp-cde:
    name: aspsp-cde
    in: path
    description: Identification of the aspsp
    required: true
    type: string
    default: ""
  account-id:
    name: account-id
    in: path
    description: Identification of the account.
    required: true
    type: string
    default: ""
  tppRedirectPreferred:
    name: tppRedirectPreferred
    in: query
    description: |
      If it equals “true”, the TPP prefers a redirect over an embedded SCA approach. If it equals “false”, the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
    required: false
    type: boolean
    default: false
  withBalance:
    name: withBalance
    in: query
    description: Reserved for future use. This parameter may only be used together
      with the access sub attribute “available-accounts” in the request body. \n\nThe
      request is rejected if the ASPSP is not NextGenPSD2 supporting this parameter.\n\nIf
      the ASPSP accepts this parameter in the /consents endpoint, he shall also accept
      it for the GET access method on the /accounts endpoint.\n
    required: false
    type: boolean
    default: false
  psuInvolved:
    name: psuInvolved
    in: query
    description: |
      It must be contained if the PSU has asked for this account access in real-time. This flag is then set to "true". The PSU then might be involved in an additional consent process, if the given consent is not any more sufficient.
    required: false
    type: boolean
    default: false
  dateFrom:
    name: dateFrom
    in: query
    description: |
      Starting date of the transaction list, mandated if no delta access is required
    required: false
    type: string
    format: date
    default: "1900-01-01"
  dateTo:
    name: dateTo
    in: query
    description: |
      End date of the transaction list, default is now if not given.
    required: false
    type: string
    format: date
    default: "1900-01-01"
  transactionId:
    name: transactionId
    in: query
    description: |
      This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification transactionId alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries “dateFrom” and “dateTo” might be ignored by the ASPSP if a delta report is supported.
    required: false
    type: string
    default: ""
  bookingStatus:
    name: bookingStatus
    in: query
    description: |
      Permitted codes are “booked”, “pending” and “both” . “booked” and “both” are to be supported mandatorily by the ASPSP. To support the “pending” feature is optional for the ASPSP, Error code if not supported in the online banking frontend
    required: true
    type: string
    enum:
    - booked
    - pending
    - both
    default: both
  deltaList:
    name: deltaList
    in: query
    description: |
      This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported.
    type: boolean
    default: false
  Consent-ID:
    name: Consent-ID
    in: header
    description: Shall be contained since “Establish Consent Transaction” was performed
      via this API before.
    required: true
    type: string
    default: ""
  TPP-Transaction-ID:
    name: TPP-Transaction-ID
    in: header
    description: ID of the transaction as determined by the initiating party.
    required: true
    type: string
    format: uuid
    default: ""
  TPP-Request-ID:
    name: TPP-Request-ID
    in: header
    description: ID of the request, unique to the call, as determined bu the initiating
      party.
    required: true
    type: string
    format: uuid
    default: ""
  PSU-ID:
    name: PSU-ID
    in: header
    description: User identification in ASPSP
    required: false
    type: string
    default: ""
  PSU-ID-Type:
    name: PSU-ID-Type
    in: header
    description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs
      as access possibility.
    required: false
    type: string
    default: ""
  PSU-Corporate-ID:
    name: PSU-Corporate-ID
    in: header
    description: Corporate User identification in ASPSP
    required: false
    type: string
    default: ""
  PSU-Corporate-ID-Type:
    name: PSU-Corporate-ID-Type
    in: header
    description: Might be mandated in the ASPSPs documentation. Only used in a corporate
      context.
    required: false
    type: string
    default: ""
  TPP-Redirect-URI:
    name: TPP-Redirect-URI
    in: header
    description: URI of the TPP, where the transaction flow shall be redirected to
      after a Redirect. Shall be contained at least if the tppRedirectPreferred parameter
      is set to true or is missing.
    required: false
    type: string
    default: ""
  Signature:
    name: Signature
    in: header
    description: A signature of the request by the TPP on application level. This
      might be mandated by ASPSP.
    required: true
    type: string
    default: ""
  TPP-Certificate:
    name: TPP-Certificate
    in: header
    description: The certificate used for signing the request, in base64 encoding.
      Shall be contained if the signature is used.
    required: true
    type: string
    default: ""
  Accept:
    name: Accept
    in: header
    description: |
      The TPP can indicate the formats of account reports supported together with a priorisation following the http header definition. The formats supported by this specification are

        - xml

        - JSON

        - text

      Further definition of content by ASPSP/ communities cp. Annex B.
    required: false
    type: string
    default: ""
  Date:
    name: Date
    in: header
    description: Request date
    required: true
    type: string
    format: date-time
  Digest:
    name: Digest
    type: string
    required: false
    in: header
    description: Hash of the message body. Should be present when Request body exists
    default: ""
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
security:
- x-ibm-client-id: []
securityDefinitions:
  x-ibm-client-id:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://site2.sibsapimarket.com:8445/sibs/apimarket-sb
  type:
  - production
  - development
- endpointUrl: https://site1.sibsapimarket.com:8445/sibs/apimarket-sb
  type:
  - production
  - development
...