Qwist Loans API

openapi: 3.2.0
info:
  title: nrich Loans 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: Loans
paths:
  /rest/access/{access-id}/loans:
    get:
      summary: List loans of access
      operationId: listLoansOfAccess
      description: Retrieve a list of available loans for this access.
      tags:
      - Loans
      parameters:
      - $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0'
      security:
      - user_auth: []
      responses:
        '200':
          $ref: '#/paths/~1rest~1loans/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/loans:
    get:
      summary: List loans
      operationId: listLoans
      description: Retrieve a list of all available loans.
      tags:
      - Loans
      security:
      - user_auth: []
      responses:
        '200':
          description: List of loans.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/paths/~1rest~1loans~1{loan-id}/get/responses/200/content/application~1json/schema'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
        4XX:
          description: Generic error.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1catalog/get/responses/401/content/application~1json/schema'
  /rest/loans/{loan-id}:
    get:
      summary: Get loan
      operationId: getLoan
      description: Get loan by ID.
      tags:
      - Loans
      parameters:
      - name: loan-id
        in: path
        required: true
        schema:
          type: string
          example: L12345.6
          description: nrich ID of the loan.
      security:
      - user_auth: []
      responses:
        '200':
          description: Loan details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/paths/~1rest~1loans~1{loan-id}/get/parameters/0/schema'
                  access_id:
                    $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0/schema'
                  name:
                    type: string
                    description: Name of the loan product.
                    example: Cash Plus Now
                  type:
                    type: string
                    enum:
                    - BUSINESS
                    - PERSONAL
                    - MORTGAGE
                    description: The type of the loan indicating its usage.
                    example: PERSONAL
                  reference_id:
                    type: string
                    description: Reference or identification code for the loan product as provided by the bank.
                    example: 904404405
                  linked_account:
                    type: string
                    description: Identification of the account from which the installments are deducted. This is usually an IBAN.
                    example: DE93300308800013441006
                  borrower:
                    type: object
                    description: Details about the borrowing party.
                    properties:
                      id:
                        type: string
                        description: Identification number. For Spanish loans this can be the NIF/NIE.
                        example: X12345678A
                      name:
                        type: string
                        description: The name of the borrowing party.
                        example: Jose Gonzales
                    required:
                    - name
                  currency:
                    type: string
                    format: ISO 4217:2015
                    default: EUR
                    description: Three-letter currency code.
                  principal:
                    type: number
                    format: float
                    description: The original amount of money that was agreed to borrow.
                    example: 30000
                  balance:
                    type: number
                    format: float
                    description: The amount of of money that is still owed to the lender. This is usually a negative value.
                    example: -15300
                  matures_on:
                    $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                    description: The date on which the loan was agreed to be paid back.
                    example: '2023-12-01'
                  interest:
                    type: object
                    properties:
                      rate:
                        type: number
                        format: float
                        description: The interest rate in percent.
                        example: 3.5
                      type:
                        type: string
                        enum:
                        - FIXED
                        - VARIABLE
                        description: Indicates if the interest rate is fixed or variable throughout the runtime of the loan.
                    required:
                    - rate
                    - type
                  next_payment_on:
                    $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                    description: The date on which the next installment is due to be paid.
                    example: '2023-02-01'
                  next_payment_amount:
                    type: number
                    format: float
                    description: The money amount to be paid with the next installment.
                    example: 1000
                  last_payment_on:
                    $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
                    description: The date on which the last installment was paid.
                    example: '2023-01-01'
                  last_payment_amount:
                    type: number
                    format: float
                    description: The money amount that was paid with the last installment.
                    example: 1000
                  created_at:
                    $ref: '#/paths/~1rest~1accesses/get/responses/200/content/application~1json/schema/items/properties/created_at'
                  modified_at:
                    description: Entity modification timestamp.
                    example: '2026-04-01T20:15:00.000+00:00'
                    type: string
                    format: date-time
                required:
                - id
                - access_id
                - name
                - type
                - reference_id
                - borrower
                - currency
                - principal
                - balance
                - matures_on
                - interest
                - created_at
                - modified_at
        '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