
---
swagger: '2.0'
info:
  description: Instant Reporting API
  version: '4.0'
  title: Instant Reporting API
  contact:
    name: Open Banking team
    url: https://nordeaopenbanking.com
    email: support@nordeaopenbanking.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-ibm-name: instant-reporting-v4
  x-version: '4.0'
host: https://api.nordeaopenbanking.com
basePath: "/corporate/"
tags:
- name: accounts-v4
  description: Customer accounts
paths:
  "/premium/v4/accounts":
    get:
      tags:
      - accounts-v4
      summary: List Accounts
      operationId: getAccountsListUsingGET_3
      produces:
      - application/json
      parameters:
      - name: Signature
        in: header
        description: "A signature of request by the TPP on application level. The
          process of signing a request is described in 'Signing HTTP Messages' RFC
          draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"
          target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).
          The request signature needs to be sent in the 'Signature' HTTP header as
          described in the RFC. Additional requirements from Nordea \n - The only
          allowed algorithm is RSA-SHA256 \n- The key size for the used RSA key pair
          has to be at least 2048 bit \n- The keyId is the clientId of your application
          originating from the Nordea Developer Portal \n- We require the following
          headers to be used in the signature \n* Request without body: (request-target)
          X-Nordea-Originating-Host X-Nordea-Originating-Date \n* Request with body:
          (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date Content-type
          Digest \n* The request-target is a combination of the HTTP action verb and
          the request URI path"
        required: true
        type: string
      - name: X-IBM-Client-Id
        in: header
        description: Id of the Client
        required: true
        type: string
      - name: X-IBM-Client-Secret
        in: header
        description: Secret password generated for the Client
        required: true
        type: string
      - name: X-Nordea-Originating-Date
        in: header
        description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        required: true
        type: string
      - name: X-Nordea-Originating-Host
        in: header
        description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        required: true
        type: string
      - name: X-Nordea-Originating-User-Agent
        in: header
        description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        required: false
        type: string
      - name: X-Nordea-Originating-User-Ip
        in: header
        description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        required: false
        type: string
      - name: page
        in: query
        description: Page number
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: size
        in: query
        description: Page size
        required: false
        type: string
        x-availabilityStatus: Beta
      responses:
        '200':
          description: List of accounts
          schema:
            "$ref": "#/definitions/AccountListResponse"
        '400':
          description: Bad Request
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '401':
          description: |-
            Unauthorized with failure code:
            * error.apikey.missing = Missing API key. This operation requires API key, but it was missing.
            * error.token = Unspecified error with supplied token.
            * error.token.invalid = Missing access token or token did not authorized requested operation. This operation requires valid access token, but it was missing.
            * error.token.expired = Access token has expired.
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '403':
          description: Login failure
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '404':
          description: Resource not found
          schema:
            "$ref": "#/definitions/ErrorResponse"
      security:
      - DecoupledAuth:
        - ACCOUNTS_BROADBAND
      deprecated: false
      x-availabilityStatus: Beta
  "/premium/v4/accounts/filter":
    post:
      tags:
      - accounts-v4
      summary: Filter Accounts
      operationId: getFilteredAccountListUsingPOST_3
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Digest
        in: header
        description: 'The Digest Header header as defined in [RFC3230] contains a
          Hash of the message body. The only hash algorithms that may be used to calculate
          the Digest within the context of this specification are SHA-256 and SHA-512
          as defined in [RFC5843]. For POST with ''application/x-www-form-urlencoded''
          content type Digest should be calculated for normalized string created from
          request parameters like this: ''param1&#61;value1&#38;param2&#61;value2''.
          It is important that parameters should be placed in alphabetic order'
        required: true
        type: string
      - name: Signature
        in: header
        description: "A signature of request by the TPP on application level. The
          process of signing a request is described in 'Signing HTTP Messages' RFC
          draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"
          target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).
          The request signature needs to be sent in the 'Signature' HTTP header as
          described in the RFC. Additional requirements from Nordea \n - The only
          allowed algorithm is RSA-SHA256 \n- The key size for the used RSA key pair
          has to be at least 2048 bit \n- The keyId is the clientId of your application
          originating from the Nordea Developer Portal \n- We require the following
          headers to be used in the signature \n* Request without body: (request-target)
          X-Nordea-Originating-Host X-Nordea-Originating-Date \n* Request with body:
          (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date Content-type
          Digest \n* The request-target is a combination of the HTTP action verb and
          the request URI path"
        required: true
        type: string
      - name: X-IBM-Client-Id
        in: header
        description: Id of the Client
        required: true
        type: string
      - name: X-IBM-Client-Secret
        in: header
        description: Secret password generated for the Client
        required: true
        type: string
      - name: X-Nordea-Originating-Date
        in: header
        description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        required: true
        type: string
      - name: X-Nordea-Originating-Host
        in: header
        description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        required: true
        type: string
      - name: X-Nordea-Originating-User-Agent
        in: header
        description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        required: false
        type: string
      - name: X-Nordea-Originating-User-Ip
        in: header
        description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        required: false
        type: string
      - in: body
        name: filterRequest
        description: Request for filtered accounts
        required: false
        schema:
          "$ref": "#/definitions/AccountFilterRequest"
        x-availabilityStatus: Beta
      - name: page
        in: query
        description: Page number
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: size
        in: query
        description: Page size
        required: false
        type: string
        x-availabilityStatus: Beta
      responses:
        '200':
          description: Filtered list of accounts
          schema:
            "$ref": "#/definitions/AccountListResponse"
        '400':
          description: Bad Request
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '401':
          description: |-
            Unauthorized with failure code:
            * error.apikey.missing = Missing API key. This operation requires API key, but it was missing.
            * error.token = Unspecified error with supplied token.
            * error.token.invalid = Missing access token or token did not authorized requested operation. This operation requires valid access token, but it was missing.
            * error.token.expired = Access token has expired.
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '403':
          description: Login failure
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '404':
          description: Resource not found
          schema:
            "$ref": "#/definitions/ErrorResponse"
      security:
      - DecoupledAuth:
        - ACCOUNTS_BROADBAND
      deprecated: false
      x-availabilityStatus: Beta
  "/premium/v4/accounts/{account_id}":
    get:
      tags:
      - accounts-v4
      summary: Account details
      operationId: getAccountDetailsUsingGET_3
      produces:
      - application/json
      parameters:
      - name: Signature
        in: header
        description: "A signature of request by the TPP on application level. The
          process of signing a request is described in 'Signing HTTP Messages' RFC
          draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"
          target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).
          The request signature needs to be sent in the 'Signature' HTTP header as
          described in the RFC. Additional requirements from Nordea \n - The only
          allowed algorithm is RSA-SHA256 \n- The key size for the used RSA key pair
          has to be at least 2048 bit \n- The keyId is the clientId of your application
          originating from the Nordea Developer Portal \n- We require the following
          headers to be used in the signature \n* Request without body: (request-target)
          X-Nordea-Originating-Host X-Nordea-Originating-Date \n* Request with body:
          (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date Content-type
          Digest \n* The request-target is a combination of the HTTP action verb and
          the request URI path"
        required: true
        type: string
      - name: X-IBM-Client-Id
        in: header
        description: Id of the Client
        required: true
        type: string
      - name: X-IBM-Client-Secret
        in: header
        description: Secret password generated for the Client
        required: true
        type: string
      - name: X-Nordea-Originating-Date
        in: header
        description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        required: true
        type: string
      - name: X-Nordea-Originating-Host
        in: header
        description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        required: true
        type: string
      - name: X-Nordea-Originating-User-Agent
        in: header
        description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        required: false
        type: string
      - name: X-Nordea-Originating-User-Ip
        in: header
        description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        required: false
        type: string
      - name: account_id
        in: path
        description: Internal, technical account identifier
        required: true
        type: string
        x-availabilityStatus: Beta
      responses:
        '200':
          description: Account details
          schema:
            "$ref": "#/definitions/AccountDetailsResponse"
        '400':
          description: Bad Request
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '401':
          description: |-
            Unauthorized with failure code:
            * error.apikey.missing = Missing API key. This operation requires API key, but it was missing.
            * error.token = Unspecified error with supplied token.
            * error.token.invalid = Missing access token or token did not authorized requested operation. This operation requires valid access token, but it was missing.
            * error.token.expired = Access token has expired.
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '403':
          description: Login failure
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '404':
          description: Account not found
          schema:
            "$ref": "#/definitions/ErrorResponse"
      security:
      - DecoupledAuth:
        - ACCOUNTS_BROADBAND
      deprecated: false
      x-availabilityStatus: Beta
  "/premium/v4/accounts/{account_id}/transactions":
    get:
      tags:
      - accounts-v4
      summary: List Transactions
      operationId: getTransactionsUsingGET_3
      produces:
      - application/json
      parameters:
      - name: Signature
        in: header
        description: "A signature of request by the TPP on application level. The
          process of signing a request is described in 'Signing HTTP Messages' RFC
          draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"
          target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).
          The request signature needs to be sent in the 'Signature' HTTP header as
          described in the RFC. Additional requirements from Nordea \n - The only
          allowed algorithm is RSA-SHA256 \n- The key size for the used RSA key pair
          has to be at least 2048 bit \n- The keyId is the clientId of your application
          originating from the Nordea Developer Portal \n- We require the following
          headers to be used in the signature \n* Request without body: (request-target)
          X-Nordea-Originating-Host X-Nordea-Originating-Date \n* Request with body:
          (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date Content-type
          Digest \n* The request-target is a combination of the HTTP action verb and
          the request URI path"
        required: true
        type: string
      - name: X-IBM-Client-Id
        in: header
        description: Id of the Client
        required: true
        type: string
      - name: X-IBM-Client-Secret
        in: header
        description: Secret password generated for the Client
        required: true
        type: string
      - name: X-Nordea-Originating-Date
        in: header
        description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        required: true
        type: string
      - name: X-Nordea-Originating-Host
        in: header
        description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        required: true
        type: string
      - name: X-Nordea-Originating-User-Agent
        in: header
        description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        required: false
        type: string
      - name: X-Nordea-Originating-User-Ip
        in: header
        description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        required: false
        type: string
      - name: account_id
        in: path
        description: Internal, technical account identifier
        required: true
        type: string
        x-availabilityStatus: Beta
      - name: continuation_key
        in: query
        description: Resource listing may return a continuationKey if there is more
          results available. Request may be retried with the continuationKey, but
          otherwise same parameters, in order to get more results.
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: from_date
        in: query
        description: List transactions starting from and including this date
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: from_transaction
        in: query
        description: List any transactions booked after (later than) the specified
          from_transaction
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: language
        in: query
        description: Preferred language for text values
        required: false
        type: string
        x-availabilityStatus: Beta
      - name: to_date
        in: query
        description: List transactions until and including this date
        required: false
        type: string
        x-availabilityStatus: Beta
      responses:
        '200':
          description: List of account transactions
          schema:
            "$ref": "#/definitions/TransactionListResponse"
        '400':
          description: Bad Request
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '401':
          description: |-
            Unauthorized with failure code:
            * error.apikey.missing = Missing API key. This operation requires API key, but it was missing.
            * error.token = Unspecified error with supplied token.
            * error.token.invalid = Missing access token or token did not authorized requested operation. This operation requires valid access token, but it was missing.
            * error.token.expired = Access token has expired.
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '403':
          description: Login failure
          schema:
            "$ref": "#/definitions/ErrorResponse"
        '404':
          description: Account not found
          schema:
            "$ref": "#/definitions/ErrorResponse"
      security:
      - DecoupledAuth:
        - ACCOUNTS_BROADBAND
      deprecated: false
      x-availabilityStatus: Beta
securityDefinitions:
  DecoupledAuth:
    type: oauth2
    authorizationUrl: "/v2/authorize"
    tokenUrl: "/v2/authorize/token"
    flow: accessCode
    scopes:
      ACCOUNTS_BROADBAND: Scope used for Instant Reporting
    x-addAuthorizerDescription: Send authorization request to relevant agreement administrator
    x-addAuthorizerUrl: "/v2/authorize"
    x-authSubType: decoupled-auth
    x-codeStatusDescription: Returns code when authorization second step is finished
    x-codeStatusUrl: "/v2/authorize"
definitions:
  AccountDetailsResponse:
    type: object
    properties:
      group_header:
        description: Standard format response header
        "$ref": "#/definitions/ResponseHeader"
        x-availabilityStatus: Stable
      response:
        description: Payload
        "$ref": "#/definitions/AccountInfo"
        x-availabilityStatus: Stable
    title: AccountDetailsResponse
    description: Account details response
  AccountFilterRequest:
    type: object
    properties:
      account_list:
        type: array
        example:
        - SE0295000099604213908314
        description: Account List
        items:
          type: string
        x-availabilityStatus: Stable
      country_list:
        type: array
        example:
        - SEK
        description: Country List
        items:
          type: string
        x-availabilityStatus: Stable
      currency_list:
        type: array
        example:
        - SE
        description: Currency List
        items:
          type: string
        x-availabilityStatus: Stable
    title: AccountFilterRequest
    description: Request for filtered accounts
  AccountInfo:
    type: object
    required:
    - _id
    - account_type
    - bic
    - booked_balance
    - country
    - currency
    - iban
    - product
    - status
    properties:
      _id:
        type: string
        description: Internal, technical account identifier
        x-availabilityStatus: Stable
      _links:
        type: array
        description: 'HATEOAS inspired links: ''rel'' and ''href'''
        items:
          "$ref": "#/definitions/Link"
        x-availabilityStatus: Stable
      account_name:
        type: string
        description: Account name
        x-availabilityStatus: Stable
      account_short_name:
        type: string
        description: Company defined name
        x-availabilityStatus: Stable
      account_type:
        type: string
        description: Account type
        x-availabilityStatus: Stable
      available_balance:
        type: string
        example: 3451.12
        description: Available balance indicates the funds which are available to
          the account holder at the time of the query
        x-availabilityStatus: Stable
      bban:
        type: string
        description: Basic Bank Account Number
        x-availabilityStatus: Stable
      bic:
        type: string
        example: NDEASESS
        description: Bank Identifier Code
        x-availabilityStatus: Stable
      booked_balance:
        type: string
        example: 3451.12
        description: Booked balance includes all transactions entered on the account
          at the time of the query
        x-availabilityStatus: Stable
      branch_code:
        type: string
        description: Local branch code
        x-availabilityStatus: Stable
      country:
        type: string
        example: SE
        description: Country code where the account is held according to ISO ALPHA-2
        x-availabilityStatus: Stable
      credit_limit:
        type: string
        example: 3451.12
        description: Amount of credit extended to account holder beyond account booked
          balance
        x-availabilityStatus: Stable
      currency:
        type: string
        example: SEK
        description: Currency code according to ISO 4217
        x-availabilityStatus: Stable
      error_description:
        type: string
        description: Detailed description of the error status.
        x-availabilityStatus: Stable
      error_status:
        type: string
        description: |-
          Status that is returned in case of failure.
          * NOT_FOUND = Account information is not accessible.
          * ERROR_OCCURRED = Returned when unexpected error happen while getting the account details.
        enum:
        - NOT_FOUND
        - ERROR_OCCURRED
        x-availabilityStatus: Stable
      group_account_type:
        type: string
        description: |-
          Account type of group account.
          Only for Cash Pool accounts.
        enum:
        - GMA
        - GCT
        - GCS
        - GSA
        - GTR
        - MA
        - CT
        - CS
        - SA
        - TR
        - TA
        x-availabilityStatus: Stable
      iban:
        type: string
        description: International Bank Account Number
        x-availabilityStatus: Stable
      latest_transaction_booking_date:
        type: string
        description: Date of last transaction booked to the account
        x-availabilityStatus: Stable
      legal_balance:
        type: string
        description: |-
          Indicates if the balances are on-balance or off-balance.
          Only for Cash Pool accounts.
        enum:
        - Y
        - N
        x-availabilityStatus: Stable
      master_account_number:
        type: string
        description: |-
          Master account number in group account hierarchy.
          Only for Cash Pool accounts.
        x-availabilityStatus: Stable
      opening_balance:
        type: string
        example: 3451.12
        description: This is the booked balance on the account at the beginning of
          the period. It equals the closing balance of the previous business day
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      plusgiro:
        type: string
        description: Plusgiro number (only used in Sweden)
        x-availabilityStatus: Stable
      product:
        type: string
        description: Name of the banking product delivered by this account
        x-availabilityStatus: Stable
      status:
        type: string
        description: Status of account
        x-availabilityStatus: Stable
      value_dated_balance:
        type: string
        example: 3451.12
        description: Value dated balance is the balance on the basis of which interest
          is calculated on the account
        x-availabilityStatus: Stable
    title: AccountInfo
    description: Account information
  AccountList:
    type: object
    properties:
      _links:
        type: array
        description: 'HATEOAS inspired links: ''rel'' and ''href'''
        items:
          "$ref": "#/definitions/Link"
        x-availabilityStatus: Stable
      accounts:
        type: array
        description: List of accounts
        items:
          "$ref": "#/definitions/AccountInfo"
        x-availabilityStatus: Stable
    title: AccountList
    description: List of accounts
  AccountListResponse:
    type: object
    properties:
      group_header:
        description: Standard format response header
        "$ref": "#/definitions/ResponseHeader"
        x-availabilityStatus: Stable
      response:
        description: Payload
        "$ref": "#/definitions/AccountList"
        x-availabilityStatus: Stable
    title: AccountListResponse
    description: Account list response
  ErrorPayload:
    type: object
    properties:
      failures:
        type: array
        description: More details on the occurred error
        items:
          "$ref": "#/definitions/Failure"
        x-availabilityStatus: Stable
      request:
        description: Error details
        "$ref": "#/definitions/RequestEcho"
        x-availabilityStatus: Stable
    title: ErrorPayload
    description: Error response body
  ErrorResponse:
    type: object
    properties:
      error:
        description: Payload
        "$ref": "#/definitions/ErrorPayload"
        x-availabilityStatus: Stable
      group_header:
        description: Standard format response header
        "$ref": "#/definitions/ResponseHeader"
        x-availabilityStatus: Stable
    title: ErrorResponse
    description: Error response
  Failure:
    type: object
    properties:
      code:
        type: string
        description: Failure code
        x-availabilityStatus: Stable
      description:
        type: string
        description: Failure description
        x-availabilityStatus: Stable
      path:
        type: string
        description: JSON path of the failing element if applicable
        x-availabilityStatus: Stable
      type:
        type: string
        description: Type of the validation error, e.g. NotNull
        x-availabilityStatus: Stable
    title: Failure
    description: Validation error
  Link:
    type: object
    properties:
      href:
        type: string
        description: Relative path to the linked resource
        x-availabilityStatus: Stable
      rel:
        type: string
        description: Describes the nature of the link, e.g. 'details' for a link to
          the detailed information of a listed resource.
        x-availabilityStatus: Stable
    title: Link
    description: Context specific link (only GET supported)
  RequestEcho:
    type: object
    properties:
      url:
        type: string
        description: Original request url
        x-availabilityStatus: Stable
    title: RequestEcho
    description: Original request information
  ResponseHeader:
    type: object
    properties:
      creation_date_time:
        type: string
        format: date-time
        description: Response creation time
        x-availabilityStatus: Stable
      http_code:
        type: integer
        format: int32
        example: 200
        description: HTTP code for response
        x-availabilityStatus: Stable
      message_identification:
        type: string
        description: Original request id for correlation purposes
        x-availabilityStatus: Stable
    title: ResponseHeader
    description: External response header
  Transaction:
    type: object
    required:
    - amount
    - booking_date
    - currency
    - status
    - type_description
    - value_date
    properties:
      amount:
        type: string
        example: 123.45
        description: Transaction value
        x-availabilityStatus: Stable
      archive_code:
        type: string
        description: Archive Code
        x-availabilityStatus: Stable
      balance_after_transaction:
        type: string
        example: 3451.12
        description: Balance on account after transaction executed
        x-availabilityStatus: Stable
      booking_date:
        type: string
        description: Date transaction was booked to the account ledger
        x-availabilityStatus: Stable
      card_number:
        type: string
        description: Card number.
        x-availabilityStatus: Stable
      charge_type:
        type: string
        description: The way in which the service fee of the transaction was charged.
        x-availabilityStatus: Stable
      correction_flag:
        type: string
        description: Indicates if the transaction is a correction transaction or not
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      correspondent_bic:
        type: string
        description: Via bank's SWIFT/ BIC if the counterparty requests that the payment
          should be sent via another bank to the counterparty's bank.
        x-availabilityStatus: Stable
      counterparty_account:
        type: string
        description: Counterparty's account number.
        x-availabilityStatus: Stable
      counterparty_address:
        type: string
        description: Address of the counterparty.
        x-availabilityStatus: Stable
      counterparty_bank_address:
        type: string
        description: Address of the bank with which the counterparty's account is
          held.
        x-availabilityStatus: Stable
      counterparty_bank_bic:
        type: string
        description: SWIFT (BIC) address of the counterparty's bank.
        x-availabilityStatus: Stable
      counterparty_bank_name:
        type: string
        description: Name of the bank with which the counterparty's account is held.
        x-availabilityStatus: Stable
      counterparty_name:
        type: string
        description: Counterparty name
        x-availabilityStatus: Stable
      currency:
        type: string
        description: Currency code according to ISO 4217
        x-availabilityStatus: Stable
      currency_rate:
        type: string
        example: 0.80654
        description: Currency exchange rate applied to foreign currency transactions
        x-availabilityStatus: Stable
      debtor_id:
        type: string
        description: Payer id
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      end_to_end_reference:
        type: string
        description: |-
          Unique identification, as assigned by the initiating party, to unambiguously identify the transaction.
          This identification is passed on, unchanged, throughout the entire end-to-end chain.
        x-availabilityStatus: Stable
      exchange_rate_reference:
        type: string
        description: The reference to the FX (Foreign Exchange) deal made with the
          bank for this specific transaction
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      extra_info:
        type: string
        description: Extra information
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      message:
        type: string
        description: A short message text provided by the remitter to the beneficiary
        x-availabilityStatus: Stable
      narrative:
        type: string
        description: Description of transaction
        x-availabilityStatus: Stable
      original_archive_code:
        type: string
        description: Original archive code of the transaction
        x-availabilityInfo: Currently only available in Sandbox
        x-availabilityStatus: Beta
      original_currency:
        type: string
        description: Currency of original transaction
        x-availabilityStatus: Stable
      original_currency_amount:
        type: string
        example: 3451.12
        description: Foreign transaction amount in original currency
        x-availabilityStatus: Stable
      own_message:
        type: string
        description: Text message for the account holder's own use
        x-availabilityStatus: Stable
      payee_alias:
        type: string
        description: Payee Alias
        x-availabilityStatus: Stable
      payer_alias:
        type: string
        description: Payer Alias
        x-availabilityStatus: Stable
      payment_date:
        type: string
        description: Payment date of the transaction
        x-availabilityStatus: Stable
      payment_urgency:
        type: string
        description: Urgency of the payment.
        x-availabilityStatus: Stable
      reference:
        type: string
        description: Reference number
        x-availabilityStatus: Stable
      status:
        type: string
        example: billed
        description: Status of the transaction
        x-availabilityStatus: Stable
      transaction_date:
        type: string
        description: Date on which transaction was enacted
        x-availabilityStatus: Stable
      transaction_id:
        type: string
        description: Transaction identifier as defined by the bank
        x-availabilityStatus: Stable
      transfer_purpose:
        type: string
        description: Transfer purpose code.
        x-availabilityStatus: Stable
      type_description:
        type: string
        example: ATM Cash Withdrawal
        description: Description of the type of transaction, e.g. Cash withdrawal,
          Account transfer, etc. (localized)
        x-availabilityStatus: Stable
      ultimate_creditor_address:
        type: string
        description: Address of ultimate party to which an amount of money is due.
        x-availabilityStatus: Stable
      ultimate_creditor_id:
        type: string
        description: Id of ultimate party to which an amount of money is due.
        x-availabilityStatus: Stable
      ultimate_creditor_name:
        type: string
        description: Name of ultimate party to which an amount of money is due.
        x-availabilityStatus: Stable
      ultimate_debtor_id:
        type: string
        description: Id of ultimate party that owes an amount of money to (ultimate)
          creditor.
        x-availabilityStatus: Stable
      ultimate_debtor_name:
        type: string
        description: Name of ultimate party that owes an amount of money to (ultimate)
          creditor.
        x-availabilityStatus: Stable
      value_date:
        type: string
        description: Value date of the transaction, used for interest calculation
        x-availabilityStatus: Stable
    title: Transaction
    description: Details of individual transaction
  TransactionList:
    type: object
    properties:
      _links:
        type: array
        description: 'HATEOAS inspired links: ''rel'' and ''href'''
        items:
          "$ref": "#/definitions/Link"
        x-availabilityStatus: Stable
      continuation_key:
        type: string
        description: Resource listing may return a continuationKey if there is more
          results available. Request may be retried with the continuationKey, but
          otherwise same parameters, in order to get more results.
        x-availabilityStatus: Stable
      transactions:
        type: array
        description: Listed transactions
        items:
          "$ref": "#/definitions/Transaction"
        x-availabilityStatus: Stable
    title: TransactionList
    description: List of transactions
  TransactionListResponse:
    type: object
    properties:
      group_header:
        description: Standard format response header
        "$ref": "#/definitions/ResponseHeader"
        x-availabilityStatus: Stable
      response:
        description: Payload
        "$ref": "#/definitions/TransactionList"
        x-availabilityStatus: Stable
    title: TransactionListResponse
    description: Transaction history response
