Qwist Accounts API

openapi: 3.2.0
info:
  title: nrich Accounts API
  version: '2.10'
  contact:
    name: Qwist GmbH
    email: partnersupport@qwist.com
    url: https://qwist.com
  description: This is the reference for Qwist's nrich API
servers:
- url: https://api.nrich.qwist.cloud
  description: Staging environment
tags:
- name: Accounts
paths:
  /rest/accesses/{access-id}/accounts:
    get:
      tags:
      - Accounts
      summary: List accounts of access
      operationId: listAccountsOfAccess
      description: Get a list of accounts that belong to this access.
      parameters:
      - $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0'
      security:
      - user_auth: []
      responses:
        '200':
          $ref: '#/paths/~1rest~1accounts/get/responses/200'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
  /rest/accounts:
    get:
      tags:
      - Accounts
      summary: List accounts
      operationId: listAccounts
      description: Get a list of all available accounts to which the user has granted access.
      security:
      - user_auth: []
      responses:
        '200':
          description: List of accounts.
          content:
            application/json:
              schema:
                type: object
                description: List of accounts
                properties:
                  accounts:
                    type: array
                    items:
                      $ref: '#/paths/~1rest~1accounts~1{account-id}/get/responses/200/content/application~1json/schema'
                required:
                - accounts
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
  /rest/accounts/{account-id}:
    get:
      summary: Get account
      operationId: getAccount
      description: Retrieve detailed information about an account identified by its ID.
      tags:
      - Accounts
      security:
      - user_auth: []
      parameters:
      - name: account-id
        in: path
        required: true
        schema:
          type: string
          example: A12345.6
          description: nrich ID of account.
      - $ref: '#/paths/~1rest~1payments/get/parameters/5'
      responses:
        '200':
          description: Account details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  account_id:
                    $ref: '#/paths/~1rest~1accounts~1{account-id}/get/parameters/0/schema'
                  account_number:
                    type: string
                    example: '0013441006'
                    description: Domestic account identifier.
                  bank_code:
                    type: string
                    example: '30030880'
                    description: Domestic bank code.
                  iban:
                    $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/iban'
                  bic:
                    $ref: '#/paths/~1uploads/post/requestBody/content/application~1json/schema/properties/accounts/items/properties/bic'
                  access_id:
                    $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0/schema'
                  bank_name:
                    type: string
                    description: Name of bank or financial provider.
                    example: Bank XYZ
                  icon:
                    type: object
                    properties:
                      url:
                        format: url
                        description: URL to provider icon.
                        example: https://finx-s.finleap.cloud/assets/images/accounts/default.png
                      resolutions:
                        type: object
                        description: A mapping of icon resolutions in the format `{res}x{res}` to their respective icon URLs.
                        properties:
                          48x48:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 48x48px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_48.png
                          60x60:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 60x60px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_60.png
                          72x72:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 72x72px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_72.png
                          84x84:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 84x84px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_84.png
                          96x96:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 96x96px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_96.png
                          120x120:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 120x120px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_120.png
                          144x144:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 144x144px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_144.png
                          192x192:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 192x192px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_192.png
                          256x256:
                            type: string
                            format: url
                            description: URL to provider icon in aspect ratio 256x256px.
                            example: https://finx-s.finleap.cloud/assets/images/accounts/default_256.png
                      required:
                      - url
                      - resolutions
                  currency:
                    $ref: '#/paths/~1rest~1loans~1{loan-id}/get/responses/200/content/application~1json/schema/properties/currency'
                  balance:
                    $ref: '#/paths/~1rest~1accounts~1{account-id}~1balance/get/responses/200/content/application~1json/schema/allOf/0'
                  type:
                    $ref: '#/paths/~1onetime~1account-verification/post/requestBody/content/application~1json/schema/allOf/1/properties/account_types/items'
                  name:
                    type: string
                    description: Name of the account.
                    example: Giro account
                  owner:
                    type: string
                    description: Name of the account holder.
                    example: John Doe
                  auto_sync:
                    type: boolean
                    description: Indicates if the account is automatically synchronized.
                    example: false
                  save_pin:
                    type: boolean
                    default: false
                    description: Indicates if the provider credentials are saved for this account.
                    example: true
                  supported_payments:
                    type: object
                    properties:
                      SEPA transfer:
                        type: object
                        properties:
                          allowed_recipients:
                            type: array
                            items:
                              type: string
                            description: List of account codes. The payment recipient must be one of these accounts. No restriction applies if this field is omitted.
                            example: []
                          can_be_recurring:
                            type: boolean
                            description: Indicates whether payments of this type can be recurring. This usually applies for standing orders.
                            example: false
                          can_be_scheduled:
                            type: boolean
                            description: Indicates whether payments of this type can be scheduled to be executed on a specific date. This usually applies for standing orders.
                            example: false
                          max_purpose_length:
                            type: integer
                            description: Maximum string length of purpose text.
                            example: 140
                          supported_text_keys:
                            type: array
                            items:
                              type: integer
                            description: List of supported DTA text keys.
                            example:
                            - 51
                            - 53
                        required:
                        - allowed_recipients
                        - can_be_scheduled
                        - can_be_recurring
                        - max_purpose_length
                        - supported_text_keys
                        - supported_file_formats
                      SEPA standing order:
                        $ref: '#/paths/~1rest~1accounts~1{account-id}/get/responses/200/content/application~1json/schema/properties/supported_payments/properties/SEPA transfer'
                    description: Mapping of payment types to payment parameters supported by this account.
                  is_jointly_managed:
                    type: boolean
                    example: false
                    description: Indicates that the account has been opened by two or more individuals or entities.
                  status:
                    $ref: '#/paths/~1rest~1accesses/get/responses/200/content/application~1json/schema/items/properties/status'
                required:
                - account_id
                - account_number
                - bank_code
                - access_id
                - bank_name
                - icon
                - currency
                - balance
                - type
                - name
                - auto_sync
                - save_pin
                - supported_payments
                - status
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        '404':
          $ref: '#/paths/~1auth~1token/post/responses/404'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
    delete:
      summary: Delete account
      operationId: deleteAccount
      description: Once the last remaining account of a bank contact has been removed, the provider access will be automatically removed as well.
      tags:
      - Accounts
      security:
      - user_auth: []
      parameters:
      - $ref: '#/paths/~1rest~1accounts~1{account-id}/get/parameters/0'
      responses:
        '204':
          $ref: '#/paths/~1rest~1user/delete/responses/204'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        '404':
          $ref: '#/paths/~1auth~1token/post/responses/404'
  /rest/accounts/{account-id}/balance:
    get:
      summary: Get account balance
      operationId: getAccountBalance
      description: Retrieve the balance of an account identified by its ID.
      tags:
      - Accounts
      parameters:
      - $ref: '#/paths/~1rest~1accounts~1{account-id}/get/parameters/0'
      - $ref: '#/paths/~1rest~1payments/get/parameters/5'
      security:
      - user_auth: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    balance:
                      type: number
                      format: float
                      description: Account balance. This response parameter will be omitted if the balance is not yet known.
                      example: 13.37
                    balance_date:
                      $ref: '#/paths/~1uploads/post/responses/200/content/application~1json/schema/properties/ended_at'
                      description: Bank server timestamp of `balance`. This response parameter will be omitted if the balance is not yet known.
                      example: '2018-04-01T00:00:00.000Z'
                  required:
                  - balance
                  - balance_date
                - type: object
                  properties:
                    status:
                      $ref: '#/paths/~1rest~1accesses/get/responses/200/content/application~1json/schema/items/properties/status'
                  required:
                  - status
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        '404':
          $ref: '#/paths/~1auth~1token/post/responses/404'
        4XX:
          $ref: '#/paths/~1rest~1loans/get/responses/4XX'
components:
  securitySchemes:
    user_auth:
      type: http
      description: 'In order to access any information belonging to a user, a client has to authenticate with a token linking itself to the user.  This token is called an `access token` and contains information on the client, the user and the level of access the client has to the users data. In order to authenticate using such an access token the HTTP header `Authorization` is set to `Bearer <access token>`. The  `access token` is formatted

        as a JSON Web Token according to [RFC7519](https://tools.ietf.org/html/rfc7519)


        Such an `access token` is either returned when


        * exchanging an authorization code after a successful OAuth login flow

        * logging in with the user''s credentials

        * exchanging a refresh token, which is returned at either of the aforementioned points


        **Authentication errors**


        In case of an authentication error a HTTP code 401 response is returned containing further

        details on the kind of error in the `WWW-Authenticate` header.


        In addition to the below listed scope the flags are used for simple boolean permissions.


        | Flag            | Description                                  |

        | --              | --                                           |

        | submit_payments | Allow submission of payments to bank server  |

        | offline         | Access finX API when the user is not present |

        | create_user     | Allow creation of finX accounts              |


        **Example**


        The string `"accounts=rw submit_payments"` is URL-encoded and passed as the URL

        parameter `scope`.'
      scheme: bearer
      bearerFormat: JWT
      x-bearerInfoFunc: app.decode_token
      x-scopes:
        accounts=rw: Modify accounts
        accounts=ro: Read accounts
        balance=ro: Read account balance
        securities=ro: Read securities
        transactions=ro: Read transactions
        transactions=rw: Modify transactions
        payments=ro: Read payments
        payments=rw: Create/modify payments
        submit_payments: Submit payment to service provider
        user=ro: Read user information
        user=rw: Modify user information
    client_auth:
      x-basicInfoFunc: app.basic_auth
      type: http
      scheme: basic
      description: Client authentication is performed via [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with client ID as username and client secret as password.
x-provenance:
  method: searched
  source: https://docs.qwist.com/reference
  harvested: '2026-10-21'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.qwist.com/reference/addprovideraccess.md
  - https://docs.qwist.com/reference/categorizetransactions.md
  - https://docs.qwist.com/reference/createaccesstoken.md
  - https://docs.qwist.com/reference/createaccountverification.md
  - https://docs.qwist.com/reference/createcontract.md
  - https://docs.qwist.com/reference/createincomereport.md
  - https://docs.qwist.com/reference/createmanualsync.md
  - https://docs.qwist.com/reference/createnotification.md
  - https://docs.qwist.com/reference/createonetimeaccess.md
  - https://docs.qwist.com/reference/createonetimeincomereport.md
  - https://docs.qwist.com/reference/createonetimepayment.md
  - https://docs.qwist.com/reference/createonetimeriskreport.md
  - https://docs.qwist.com/reference/createongoingaccess.md
  - https://docs.qwist.com/reference/createongoingpayment.md
  - https://docs.qwist.com/reference/createongoingriskreport.md
  - https://docs.qwist.com/reference/createpayment.md
  - https://docs.qwist.com/reference/createpaymentfromaccount.md
  - https://docs.qwist.com/reference/createqwistlink.md
  - https://docs.qwist.com/reference/createriskreport.md
  - https://docs.qwist.com/reference/createsync.md
  - https://docs.qwist.com/reference/createupload.md
  - https://docs.qwist.com/reference/createuser.md
  - https://docs.qwist.com/reference/createverifyandpay.md
  - https://docs.qwist.com/reference/deleteaccount.md
  - https://docs.qwist.com/reference/deleteclientuser.md
  - https://docs.qwist.com/reference/deletecontract.md
  - https://docs.qwist.com/reference/deletenotification.md
  - https://docs.qwist.com/reference/deletepayment.md
  - https://docs.qwist.com/reference/deleteprovideraccess.md
  - https://docs.qwist.com/reference/deleteuser.md
  - https://docs.qwist.com/reference/getaccount.md
  - https://docs.qwist.com/reference/getaccountbalance.md
  - https://docs.qwist.com/reference/getaccountverificationreceipt.md
  - https://docs.qwist.com/reference/getandgenerateincomereport.md
  - https://docs.qwist.com/reference/getartifact.md
  - https://docs.qwist.com/reference/getcategories.md
  - https://docs.qwist.com/reference/getcategoriesforaccess.md
  - https://docs.qwist.com/reference/getcategoriesforaccount.md
  - https://docs.qwist.com/reference/getcategorytree.md
  - https://docs.qwist.com/reference/getcontract.md
  - https://docs.qwist.com/reference/getcredential.md
  - https://docs.qwist.com/reference/getincomereport.md
  - https://docs.qwist.com/reference/getinsurance.md
  - https://docs.qwist.com/reference/getloan.md
  - https://docs.qwist.com/reference/getnotification.md
  - https://docs.qwist.com/reference/getpaymentchallenge.md
  - https://docs.qwist.com/reference/getpaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/getpaymentinitstatus.md
  - https://docs.qwist.com/reference/getpaymentinitstatusofaccount.md
  - https://docs.qwist.com/reference/getpaymentofaccount.md
  - https://docs.qwist.com/reference/getpaymentpartners.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccess.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccount.md
  - https://docs.qwist.com/reference/getpaymentreceipt.md
  - https://docs.qwist.com/reference/getprovideraccess.md
  - https://docs.qwist.com/reference/getriskreport.md
  - https://docs.qwist.com/reference/getsecurityofaccount.md
  - https://docs.qwist.com/reference/getsyncchallenge.md
  - https://docs.qwist.com/reference/getsyncstatus.md
  - https://docs.qwist.com/reference/gettimeline.md
  - https://docs.qwist.com/reference/gettimelineforaccess.md
  - https://docs.qwist.com/reference/gettimelineforaccount.md
  - https://docs.qwist.com/reference/gettransaction.md
  - https://docs.qwist.com/reference/gettransactionofaccount.md
  - https://docs.qwist.com/reference/getuploadstatus.md
  - https://docs.qwist.com/reference/getuser.md
  - https://docs.qwist.com/reference/getversion.md
  - https://docs.qwist.com/reference/initpayment.md
  - https://docs.qwist.com/reference/initpaymentofaccount.md
  - https://docs.qwist.com/reference/listaccounts.md
  - https://docs.qwist.com/reference/listaccountsofaccess.md
  - https://docs.qwist.com/reference/listbanks.md
  - https://docs.qwist.com/reference/listcatalog.md
  - https://docs.qwist.com/reference/listcatalogclientauth.md
  - https://docs.qwist.com/reference/listclientusers.md
  - https://docs.qwist.com/reference/listcontracts.md
  - https://docs.qwist.com/reference/listcontractsofaccess.md
  - https://docs.qwist.com/reference/listcontractsofaccount.md
  - https://docs.qwist.com/reference/listcredentials.md
  - https://docs.qwist.com/reference/listinsurances.md
  - https://docs.qwist.com/reference/listinsurancesofaccess.md
  - https://docs.qwist.com/reference/listloans.md
  - https://docs.qwist.com/reference/listloansofaccess.md
  - https://docs.qwist.com/reference/listnotifications.md
  - https://docs.qwist.com/reference/listpaymentchallenges.md
  - https://docs.qwist.com/reference/listpaymentchallengesofaccount.md
  - https://docs.qwist.com/reference/listpayments.md
  - https://docs.qwist.com/reference/listpaymentsofaccount.md
  - https://docs.qwist.com/reference/listprovideraccesses.md
  - https://docs.qwist.com/reference/listsecurities.md
  - https://docs.qwist.com/reference/listsecuritiesofaccount.md
  - https://docs.qwist.com/reference/listservices.md
  - https://docs.qwist.com/reference/listsyncchallenges.md
  - https://docs.qwist.com/reference/listtransactions.md
  - https://docs.qwist.com/reference/listtransactionsofaccount.md
  - https://docs.qwist.com/reference/patchcredential.md
  - https://docs.qwist.com/reference/removepinfromprovideraccess.md
  - https://docs.qwist.com/reference/replacenotifications.md
  - https://docs.qwist.com/reference/revokeoauthtoken.md
  - https://docs.qwist.com/reference/solvepaymentchallenge.md
  - https://docs.qwist.com/reference/solvepaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/solvesyncchallenge.md
  - https://docs.qwist.com/reference/updatecontract.md
  - https://docs.qwist.com/reference/updatenotification.md
  - https://docs.qwist.com/reference/updateuser.md
  merge:
    pages: 105
    deduped: 1107
    conflicts_kept_first: 0