openapi: 3.1.1
info:
  title: Aritma Banking API
  description: |-
    <h2>API versioning</h2>
                        <p>Over time there will be introduced changes to the API as we continuously introduce improvements. 
                        You have the option to use a specific version or the most recent version, supported versions are 
                        available in the response header <code>api-supported-versions</code>.</p>
                        <p>Use a specific version of the API by specifying the api-version header, for example <code>api-version: 1.0</code>. 
                        If you don't specify the header, the latest version will be used.
                        If a version has been scheduled to be removed, it will be reported through the api-deprecated-versions header, for example <code>api-deprecated-versions: 1.0, 1.1</code>.</p>
                        <h2>Idempotency</h2>
                        <p>The API supports idempotency for safely retrying POST requests without accidentally performing the operation twice.
                        To perform an idempotent request, specify the <code>Idempotency-Key: UUID</code> header with a value on UUID format,
                        example: <code>Idempotency-Key: 5bfa15da-0969-46a3-820d-be0ec7a16c24</code>.</p>
                        <p>The idempotency works by storing the status code and body of the first response made for the idempotency key for a short timespan, 
                        regardless of whether if succeeds or fails. Subsequent request with the same key returns the response of the previous response.
                        The presence of response header <code>Idempotent-Replayed: true</code> indicates that a previous response has been returned. 
                        Note that the replayed responses for created resources would change from status <code>201</code> to <code>200</code> ok, 
                        indicating that no resource was created.</p>
  version: 1.0.0
servers:
  - url: https://banking.dev.zdata.io/api/
paths:
  /accounts/{id}:
    get:
      tags:
        - Accounts
      operationId: GetAccount
      parameters:
        - name: id
          in: path
          description: Id of the account to retrieve
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
    delete:
      tags:
        - Accounts
      operationId: DeleteAccount
      parameters:
        - name: id
          in: path
          description: The id of the account to delete.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '202':
          description: Accepted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /accounts:
    get:
      tags:
        - Accounts
      operationId: GetAccounts
      parameters:
        - name: withBalance
          in: query
          description: If the account balance should be included
          schema:
            type: boolean
        - name: bban
          in: query
          description: The Basic Bank Account Number (BBAN) used to filter accounts.
          schema:
            type: string
        - name: iban
          in: query
          description: The International Bank Account Number (IBAN) used to filter accounts
          schema:
            type: string
        - name: search
          in: query
          description: Search for an account matching the phrase.
          schema:
            type: string
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /accounts/{id}/transactions:
    get:
      tags:
        - Accounts
      operationId: GetTransactions
      parameters:
        - name: id
          in: path
          description: Id of the account to retrieve transactions from
          required: true
          schema:
            type: string
        - name: dateFrom
          in: query
          description: Inclusive start date of the transactions
          required: true
          schema:
            type: string
            format: date-time
        - name: dateTo
          in: query
          description: Inclusive end date of the transactions
          schema:
            type: string
            format: date-time
        - name: bookingStatus
          in: query
          description: The kind of booking statuses to include
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/BookingStatus'
        - name: transactionType
          in: query
          description: The kind of Transaction
          schema:
            allOf:
              - $ref: '#/components/schemas/TransactionType'
        - name: transactionSource
          in: query
          description: The source of the transaction
          schema:
            allOf:
              - $ref: '#/components/schemas/TransactionSource'
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /accounts/{accountId}/transactions/{id}:
    get:
      tags:
        - Accounts
      operationId: GetTransactionDetails
      parameters:
        - name: accountId
          in: path
          description: Id of the account to retrieve transaction details from
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: Id of the transaction to retrieve
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionDetailsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /accounts/{id}/parameters:
    get:
      tags:
        - Accounts
      summary: Get account parameters
      operationId: GetAccountParameters
      parameters:
        - name: id
          in: path
          description: Id of the account to retrieve parameters from
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountParametersResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /accounts/{id}/balances:
    get:
      tags:
        - Accounts
      summary: Get account balances
      operationId: GetAccountBalances
      parameters:
        - name: id
          in: path
          description: Id of the account to retrieve balance from
          required: true
          schema:
            type: string
        - name: dateFrom
          in: query
          description: >-
            The start date to get balances from, balances from this date are
            included
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: ''
          schema:
            type: string
        - name: type
          in: query
          description: >-
            The type of balance to include, when not set all types will be
            returned
          schema:
            allOf:
              - $ref: '#/components/schemas/BalanceType'
        - name: PSU-IP-Address
          in: header
          description: >-
            IP Address of the PSU, it should only be set if this request was
            actively initiated by the PSU.

            Most operations have request limits that apply when a user is not
            present.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalanceResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Account not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /banks:
    get:
      tags:
        - Banks
      operationId: GetBanks
      parameters:
        - name: countryCode
          in: query
          description: Limit the results to a specific ISO 3166-1 Alpha 2 country code
          schema:
            maxLength: 2
            minLength: 2
            type: string
        - name: channels
          in: query
          description: Limit the results to one or more specific channels
          schema:
            type: array
            items:
              type: string
        - name: includeAdditionalInformation
          in: query
          description: >-
            Set as true if additional information about the bank integration
            should be included. Used for documentation purposes.
          schema:
            type: boolean
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BanksSearchResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /banks/{bankId}:
    get:
      tags:
        - Banks
      operationId: GetBank
      parameters:
        - name: bankId
          in: path
          description: Unique id of the bank to retrieve
          required: true
          schema:
            type: string
        - name: channels
          in: query
          description: Limit the results to one or more specific channels
          schema:
            type: array
            items:
              type: string
        - name: includeAdditionalInformation
          in: query
          description: >-
            Set as true if additional information about the bank integration
            should be included. Used for documentation purposes.
          schema:
            type: boolean
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - Api access:
            - services.banking
            - api
  /consents:
    post:
      tags:
        - Consents
      operationId: CreateConsent
      parameters:
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CreateConsentRequest'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CreateConsentRequest'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CreateConsentRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConsentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
    get:
      tags:
        - Consents
      operationId: GetConsents
      parameters:
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsentsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Consent not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /consents/{id}/refresh:
    put:
      tags:
        - Consents
      operationId: RefreshConsent
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/RefreshConsentRequest'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/RefreshConsentRequest'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/RefreshConsentRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConsentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /consents/{id}:
    get:
      tags:
        - Consents
      operationId: GetConsent
      parameters:
        - name: id
          in: path
          description: Id of the consent to retrieve
          required: true
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Consent not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
    delete:
      tags:
        - Consents
      operationId: DeleteConsent
      parameters:
        - name: id
          in: path
          description: Id of the consent to delete
          required: true
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Consent not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /bulk-payments/{paymentProduct}:
    post:
      tags:
        - Payments
      summary: Bulk payment initiation
      operationId: InitiatePayment
      parameters:
        - name: TPP-Redirect-URI
          in: header
          description: The url to redirect the user to after authorization
          schema:
            type: string
            format: uri
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        description: Payment details
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/PaymentRequestBulk'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/PaymentRequestBulk'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/PaymentRequestBulk'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateBulkPaymentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#bad-request
                title: Bad request
                status: 400
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
                errors:
                  Foo: Foo must be specified
                  Bar: Bar is not valid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
    get:
      tags:
        - Payments
      summary: Get bulk payments
      operationId: GetBulkPayments
      parameters:
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: createdFrom
          in: query
          description: Only payments created after this date will be fetched
          schema:
            type: string
            format: date-time
        - name: createdTo
          in: query
          description: >-
            Only payments created before this date will be fetched, should be a
            later date than createdAtDateFrom
          schema:
            type: string
            format: date-time
        - name: updatedFrom
          in: query
          description: >-
            Only payments updated after this date will be fetched, payments that
            have never been updated will also be fetched
          schema:
            type: string
            format: date-time
        - name: updatedTo
          in: query
          description: >-
            Only payments updated before this date will be fetched, payments
            that have never been updated will also be fetched, should be a later
            date than updatedAtDateFrom if it is specified
          schema:
            type: string
            format: date-time
        - name: status
          in: query
          description: Status of the payments to fetch
          schema:
            allOf:
              - $ref: '#/components/schemas/TransactionStatus'
        - name: accountId
          in: query
          description: Resource uri of the account to get payments for
          schema:
            type: string
        - name: cursor
          in: query
          description: cursor to get next or previous page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBulkPaymentsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /bulk-payments/{paymentProduct}/{paymentId}:
    get:
      tags:
        - Payments
      summary: Get bulk-payment information
      operationId: GetBulkPaymentInformation
      parameters:
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: Id of the payment initiation
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBulkPaymentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /{paymentService}/{paymentProduct}/{paymentId}/status:
    get:
      tags:
        - Payments
      summary: Get payment status
      operationId: GetPaymentStatus
      parameters:
        - name: paymentService
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentService'
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: Id of the payment initiation
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiatePaymentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /{paymentService}/{paymentProduct}/{paymentId}/authorizations:
    post:
      tags:
        - Payments
      summary: Start authorization
      operationId: StartAuthorization
      parameters:
        - name: paymentService
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentService'
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: Id of the payment initiation
          required: true
          schema:
            type: string
        - name: TPP-Redirect-URI
          in: header
          description: The url to redirect the user to after authorization.
          schema:
            type: string
            format: uri
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        description: Authentication method configuration.
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAuthorizationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /{paymentService}/{paymentProduct}/{paymentId}/authorizations/{authorizationId}:
    put:
      tags:
        - Payments
      summary: Update authorization
      operationId: UpdateAuthorization
      parameters:
        - name: paymentService
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentService'
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: Id of the payment initiation
          required: true
          schema:
            type: string
        - name: authorizationId
          in: path
          description: Id of the payment authorization
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - User access:
            - services.banking
  /{paymentService}/{paymentProduct}/{paymentId}:
    delete:
      tags:
        - Payments
      summary: Cancel a payment.
      description: >-
        This endpoint is used to cancel/delete a payment resource based on the
        provided service, product, and payment Id.
      operationId: CancelPayment
      parameters:
        - name: paymentService
          in: path
          description: The payment service.
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentService'
        - name: paymentProduct
          in: path
          description: The payment product.
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: The unique identifier of the payment.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDeleteResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /payments/{paymentProduct}/{paymentId}:
    get:
      tags:
        - Payments
      summary: Get payment information
      operationId: GetPaymentInformation
      parameters:
        - name: paymentProduct
          in: path
          description: ''
          required: true
          schema:
            allOf:
              - $ref: '#/components/schemas/PaymentProduct'
        - name: paymentId
          in: path
          description: Id of the payment initiation
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          description: A reference to a specific page
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Payment not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /signing-baskets/{basketId}:
    get:
      tags:
        - SigningBaskets
      summary: Get signing basket
      operationId: GetSigningBasket
      parameters:
        - name: basketId
          in: path
          description: Id of the basket.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningBasketResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#bad-request
                title: Bad request
                status: 400
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
                errors:
                  Foo: Foo must be specified
                  Bar: Bar is not valid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
    delete:
      tags:
        - SigningBaskets
      summary: Cancel signing basket.
      operationId: CancelSigningBasket
      parameters:
        - name: basketId
          in: path
          description: Id of basket.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IActionResult'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /signing-baskets/{basketId}/status:
    get:
      tags:
        - SigningBaskets
      summary: Get signing basket status
      operationId: GetSigningBasketStatus
      parameters:
        - name: basketId
          in: path
          description: Id of the basket.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningBasketStatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#bad-request
                title: Bad request
                status: 400
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
                errors:
                  Foo: Foo must be specified
                  Bar: Bar is not valid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /signing-baskets/{basketId}/authorizations:
    post:
      tags:
        - SigningBaskets
      summary: Start signing basket authorization
      operationId: StartSigningBasketAuthorization
      parameters:
        - name: basketId
          in: path
          description: Id of the basket.
          required: true
          schema:
            type: string
        - name: TPP-Redirect-URI
          in: header
          description: The url to redirect the user to after authorization.
          schema:
            type: string
            format: uri
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        description: Authentication method configuration.
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SelectPsuAuthenticationMethod'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAuthorizationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
  /signing-baskets/{basketId}/authorizations/{authorizationId}:
    put:
      tags:
        - SigningBaskets
      summary: Update signing basket authorization
      operationId: UpdateSigningBasketAuthorization
      parameters:
        - name: basketId
          in: path
          description: Id of the basket.
          required: true
          schema:
            type: string
        - name: authorizationId
          in: path
          description: The authorization id.
          required: true
          schema:
            type: string
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - User access:
            - services.banking
  /signing-baskets:
    post:
      tags:
        - SigningBaskets
      summary: Create a signing basket
      operationId: CreateSigningBasket
      parameters:
        - name: TPP-Redirect-URI
          in: header
          description: The url to redirect the user to after authorization.
          schema:
            type: string
            format: uri
        - name: PSU-IP-Address
          in: header
          description: IP Address of the PSU.
          schema:
            type: string
        - name: Consent-ID
          in: header
          description: >-
            The consent id. Should be set unless a specific Subscription-Id is
            used.
          schema:
            type: string
        - name: Channel-Type
          in: header
          description: The banking channel.
          schema:
            allOf:
              - $ref: '#/components/schemas/BankingChannel'
            description: The banking channel.
        - name: Subscription-Id
          in: header
          description: >-
            Id of the subscription to use. Only supported for Channel-Type
            `openBanking`.
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Resource-Group-Name
          in: header
          description: >-
            Name of the resource group to use in the specified subscription.
            Only supported for Channel-Type `openBanking`
          schema:
            pattern: ^[A-Za-z0-9_-]+$
            type: string
        - name: Scopes
          in: header
          description: >-
            Resource scopes to use, mutually exclusive with `subscriptionId`.

            - `/`: Use all resources available.

            - `/subscriptions/7fdf00601dfb`: Use all resources in subscription
            7fdf00601dfb.

            - `/subscriptions/7fdf00601dfb/resource-groups/my-company`: Use all
            resources within subscription 7fdf00601dfb and resource-group
            my-company.
          schema:
            type: array
            items:
              type: string
            example: /subscriptions/7fdf00601dfb/resource-groups/my-company
          example: /subscriptions/7fdf00601dfb/resource-groups/my-company
        - name: api-version
          in: header
          schema:
            type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SigningBasket'
          text/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SigningBasket'
          application/*+json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SigningBasket'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningBasketResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#bad-request
                title: Bad request
                status: 400
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
                errors:
                  Foo: Foo must be specified
                  Bar: Bar is not valid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-unauthorized
                title: Access unauthorized
                status: 401
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#access-forbidden
                title: Access was forbidden
                status: 403
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://developer.aritma.com/apis/banking/development/errors/#not-found
                title: Signing basket not found
                status: 404
                detail: ''
                traceId: 00-f9821bd7f70351dce24ddf4da8f3d480-3a7f8abcb3ad9b7f-01
      security:
        - Api access:
            - services.banking
            - api
components:
  schemas:
    AccountBalance:
      type: object
      properties:
        balanceAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Amount with currency
        balanceType:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/BalanceType'
        referenceDate:
          type:
            - 'null'
            - string
          format: date-time
        lastChangeDate:
          type:
            - 'null'
            - string
          format: date-time
      additionalProperties: false
      description: Balance of the account
    AccountBalanceResponse:
      required:
        - account
      type: object
      properties:
        account:
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        accountBalances:
          type: array
          items:
            $ref: '#/components/schemas/AccountBalance'
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
    AccountNumbers:
      type: object
      properties:
        iban:
          pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: IBAN of the account
          example: FR7612345987650123456789014
        bban:
          pattern: '[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: BBAN of the account - ISO 20022
          example: BARC12345612345678
        other:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/GenericAccountDto'
          description: Generic account reference.
        currency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: Currency code - ISO 4217
          example: EUR
      additionalProperties: false
    AccountOwnerDto:
      type: object
      properties:
        name:
          maxLength: 70
          type:
            - 'null'
            - string
          description: Account owner name
          example: Corporation AB
        role:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Role of the party in relation to the account.
          example: owner
        postalAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/PostalAddressDto'
          description: Postal address of the account owner.
        organisationId:
          type:
            - 'null'
            - string
          description: Organisation identification.
      additionalProperties: false
    AccountParameters:
      type: object
      properties:
        payments:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/PaymentParameters'
          description: Parameters for payments.
      additionalProperties: false
      description: Parameters for an account.
    AccountParametersResponse:
      type: object
      properties:
        account:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        parameters:
          allOf:
            - $ref: '#/components/schemas/AccountParameters'
          description: Parameters for an account.
      additionalProperties: false
    AccountReference:
      type: object
      properties:
        iban:
          pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: IBAN of the account
          example: FR7612345987650123456789014
        bban:
          pattern: '[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: BBAN of the account - ISO 20022
          example: BARC12345612345678
        other:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/GenericAccountDto'
          description: Generic account reference.
        currency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: Currency code - ISO 4217
          example: EUR
        pan:
          type:
            - 'null'
            - string
          description: Primary Account Number - ISO/IEC 7812
          example: 5409050000000000
        maskedPan:
          type:
            - 'null'
            - string
          description: Masked Primary Account Number - ISO/IEC 7812
          example: 123456xxxxxx1234
        msisdn:
          type:
            - 'null'
            - string
          description: Mobile phone number
          example: '+491701234567'
      additionalProperties: false
      description: Account reference
    AccountReport:
      type: object
      properties:
        booked:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
          description: Booked transactions
        pending:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
          description: Pending transactions
          example: []
        information:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
          description: Standing orders
          example: []
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
    AccountResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the account
          example: '1234'
        iban:
          pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: IBAN (International Bank Account Number) of the account
          example: FR7612345987650123456789014
        bban:
          pattern: '[a-zA-Z0-9]{1,30}'
          type:
            - 'null'
            - string
          description: BBAN (Basic Bank Account Number) - ISO 20022
          example: BARC12345612345678
        other:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/GenericAccountDto'
          description: Generic account reference.
        bic:
          pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
          type:
            - 'null'
            - string
          description: BICFI
          example: AAAADEBBXXX
        currency:
          type:
            - 'null'
            - string
          description: ISO 4217 Alpha 3 currency code.
          example: NOK
        name:
          type:
            - 'null'
            - string
          description: Name of the account
          example: Usage Account
        displayName:
          type:
            - 'null'
            - string
          description: Name of the account for use within online channels.
          example: My usage account
        status:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/StatusType'
          description: Status of the account. Only enabled accounts may initiate payments.
          example: enabled
        ownerName:
          type:
            - 'null'
            - string
          description: Name of the legal account owner.
          example: Corporation AB
        owner:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountOwnerDto'
          description: The party that legally owns the account.
        balances:
          type: array
          items:
            $ref: '#/components/schemas/AccountBalance'
          description: Account balances
      additionalProperties: false
      description: Account response
    AccountsResponse:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountResponse'
          description: Accounts
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
      description: Accounts response
    AdditionalInformation:
      type: object
      properties:
        heading:
          type: string
        content:
          type: string
      additionalProperties: false
    Address:
      required:
        - country
      type: object
      properties:
        streetName:
          maxLength: 70
          type:
            - 'null'
            - string
          description: Gets or Sets StreetName
        buildingNumber:
          type:
            - 'null'
            - string
          description: Gets or Sets BuildingNumber
        postCode:
          type:
            - 'null'
            - string
          description: Gets or Sets PostCode
        townName:
          type:
            - 'null'
            - string
          description: Gets or Sets TownName
        country:
          minLength: 1
          pattern: '[A-Z]{2}'
          type: string
          description: Gets or Sets Country
      additionalProperties: false
      description: Address
    AmountDetail:
      type: object
      properties:
        currency:
          type:
            - 'null'
            - string
          description: The three-letter currency code of the amount - ISO 4217
          example: NOK
        amount:
          pattern: '-?[0-9]{1,14}(\.[0-9]{1,3})?'
          type:
            - 'null'
            - string
          description: >-
            The amount value. Negative amounts are signed by minus. The decimal
            separator is a dot.
                        
            **Example:**

            * 0

            * 154

            * -1.75

            * 349.7

            * 3632.78
          example: 3632.78
        sourceCurrency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: >-
            Currency from which an amount is to be converted in a currency
            conversion
          example: EUR
        exchangeRate:
          type:
            - 'null'
            - number
          description: >-
            Factor used to convert an amount from one currency into another.
            This reflects the price at which one currency was bought with
            another currency
          format: double
        unitCurrency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: >-
            Currency in which the rate of exchange is expressed in a currency
            exchange. In the example 1EUR = xxxCUR, the unit currency is EUR
          example: EUR
        targetCurrency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: >-
            Currency into which an amount is to be converted in a currency
            conversion
          example: EUR
        quotationDate:
          type:
            - 'null'
            - string
          description: Date at which an exchange rate is quoted
          format: date-time
        contractId:
          type:
            - 'null'
            - string
          description: >-
            Unique identification to unambiguously identify the foreign exchange
            contract
      additionalProperties: false
    AmountDetails:
      type: object
      properties:
        instructedAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AmountDetail'
          description: >-
            Identifies the amount of money to be moved between the debtor and
            creditor, before

            deduction of charges, expressed in the currency as ordered by the
            initiating party and provides currency

            exchange information in case the instructed amount and/or currency
            is/are different from the entry

            amount and/or currency
        transactionAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AmountDetail'
          description: Amount of the underlying transaction
      additionalProperties: false
    BalanceType:
      enum:
        - closingBooked
        - openingBooked
        - expected
        - interimAvailable
        - interimBooked
        - forwardAvailable
        - nonInvoiced
      type: string
      description: The type of balance
      x-enumDescriptions:
        closingBooked: |-
          <summary>
                      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. For card-accounts, this is composed of invoiced, but not yet paid entries. Most requests for balances of an account belonging to a private customer will include this balancetype.
                      </summary>
        openingBooked: |-
          <summary>
                      Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
                      </summary>
        expected: |-
          <summary>
                      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. For card accounts, this is composed of invoiced, but not yet paid entries, not yet invoiced but already booked entries and pending item(not yet booked) Most requests for balances of an account belonging to a private customer will include this balancetype
                      </summary>
        interimAvailable: |-
          <summary>
                      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. For card-accounts, this is composed of invoiced, but not yet paid entries and not yet invoiced but already booked entries
                      </summary>
        interimBooked: |-
          <summary>
                      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.
                      </summary>
        forwardAvailable: |-
          <summary>
                      Forward available balance of money that is at the disposal of the account owner on the date specified.
                      </summary>
        nonInvoiced: |-
          <summary>
                      Only for card accounts, to be checked yet.
                      </summary>
    BankConsentProperties:
      type: object
      properties:
        displayName:
          type:
            - 'null'
            - string
          description: Short text providing information about the property
          example: Corporate bank id
        type:
          allOf:
            - $ref: '#/components/schemas/PropType'
          description: The type of the field
        description:
          type:
            - 'null'
            - string
          description: Additional information about the property
        enum:
          type:
            - 'null'
            - array
          items: {}
          description: If specified, the property must be one of the specified values
        pattern:
          type:
            - 'null'
            - string
          description: Regular expression
          example: ^[a-zA-Z][a-zA-Z]\\d{5}$
        minimum:
          type:
            - 'null'
            - number
          description: Minimum value that is acceptable and valid for the input
          format: double
        maximum:
          type:
            - 'null'
            - number
          description: Maximum value that is acceptable and valid for the input
          format: double
        minLength:
          type:
            - 'null'
            - integer
          description: The minimum number of characters the user can enter into an field
          format: int32
        maxLength:
          type:
            - 'null'
            - integer
          description: The maximum number of characters the user can enter into an field
          format: int32
        errorMessage:
          type:
            - 'null'
            - string
          description: Error message in case of validation error
          example: two letters followed by 5 digits.
        condition:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/PropertyCondition'
          description: >-
            An optional condition that must be met in order for this property to
            apply
      additionalProperties: false
    BankConsentProperty:
      type: object
      properties:
        displayName:
          type:
            - 'null'
            - string
          description: Short text providing information about the property
          example: Corporate bank id
      additionalProperties: false
    BankItem:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the bank
          example: 9FBEFB80-27E1-421F-A24F-467334007D39
        bic:
          type: string
          description: BIC/SWIFT code of the bank
          example: DNBANOKKXXX
        name:
          type: string
          description: Name of the bank
          example: DNB Bank ASA
        countryCode:
          type: string
          description: ISO 3166-1 Alpha 2 country code
          example: 'NO'
        channelType:
          allOf:
            - $ref: '#/components/schemas/BankingChannel'
          description: Channel of the bank
          example: psd2
        consentProperties:
          type:
            - 'null'
            - object
          additionalProperties:
            $ref: '#/components/schemas/BankConsentProperty'
          description: Attributes that can be used when creating consents
        logo:
          type: string
          description: Bank logo
        additionalInformations:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInformation'
          description: |-
            Additional information about the specific bank / integration.
            Typically used for documentation purposes.
        onboarding:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/BankOnboardingDetails'
          description: Contains information related to onboarding against a specific bank.
      additionalProperties: false
    BankOnboardingDetails:
      type: object
      properties:
        document:
          type:
            - 'null'
            - string
          description: >-
            Link to a document that describes the onboarding process for the
            bank.
        href:
          type:
            - 'null'
            - string
          description: >-
            Link to an external onboarding page that the PSU can be redirected
            to.
      additionalProperties: false
      description: Contains information related to onboarding against a specific bank.
    BankResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the bank
          example: 9FBEFB80-27E1-421F-A24F-467334007D39
        bic:
          type: string
          description: BIC/SWIFT code of the bank
          example: DNBANOKKXXX
        name:
          type: string
          description: Name of the bank
          example: DNB Bank ASA
        countryCode:
          type: string
          description: ISO 3166-1 Alpha 2 country code
          example: 'NO'
        channelType:
          allOf:
            - $ref: '#/components/schemas/BankingChannel'
          description: Channel of the bank
          example: psd2
        consentProperties:
          type:
            - 'null'
            - object
          additionalProperties:
            $ref: '#/components/schemas/BankConsentProperties'
          description: Attributes that can be used when creating consents
        logo:
          type: string
          description: Bank logo
        onboarding:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/BankOnboardingDetails'
          description: Contains information related to onboarding against a specific bank.
      additionalProperties: false
    BankingChannel:
      enum:
        - unspecified
        - openBanking
        - psd2
      type: string
      description: The banking channel.
    BanksSearchResponse:
      type: object
      properties:
        banks:
          type: array
          items:
            $ref: '#/components/schemas/BankItem'
          description: A list of banks
      additionalProperties: false
    BasketTransactionStatus:
      enum:
        - acsp
        - actc
        - acwc
        - rcvd
        - rjct
      type: string
      x-enumDescriptions:
        acsp: |-
          <summary>
                      `AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
                      </summary>
        actc: |-
          <summary>
                      `AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
                      </summary>
        acwc: |-
          <summary>
                      `AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
                      </summary>
        rcvd: |-
          <summary>
                      `Received` - Payment initiation has been received by the receiving agent.
                      </summary>
        rjct: |-
          <summary>
                      `Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.
                      </summary>
    BookingStatus:
      enum:
        - booked
        - pending
        - both
        - information
        - all
      type: string
    Charge:
      type: object
      properties:
        amount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: The charge amount.
        chargeBearer:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ChargeBearerType'
          description: >-
            Specifies which party/parties will bear the charges associated with
            the processing of the payment transaction.
      additionalProperties: false
      description: Provides details of the individual charge record.
    ChargeBearerType:
      enum:
        - debt
        - cred
        - shar
        - slev
      type: string
      description: >-
        Specifies which party/parties will bear the charges associated with the
        processing of the payment transaction.
      x-enumDescriptions:
        debt: |-
          <summary>
                      All transaction charges are to be borne by the debtor.
                      </summary>
        cred: |-
          <summary>
                      All transaction charges are to be borne by the creditor.
                      </summary>
        shar: |-
          <summary>
                      In a credit transfer context, transaction charges on the sender side are borne by the debtor,
                      and transaction charges on the receiver side are borne by the creditor.
                      In a direct debit context, transaction charges on the sender side are borne by the creditor,
                      and transaction charges on the receiver side are borne by the debtor.
                      </summary>
        slev: |-
          <summary>
                      Charges are applied following the rules agreed in the service level and/or scheme.
                      </summary>
    ClearingSystemDto:
      required:
        - memberId
      type: object
      properties:
        memberId:
          maxLength: 35
          minLength: 1
          type: string
          description: Clearing system member id
          example: USABA123456789
      additionalProperties: false
      description: >-
        Information about a clearing system member, which might be required for
        payments to non EEA member states.
    ConsentAdditionalData:
      type: object
      properties:
        bankId:
          type:
            - 'null'
            - string
          description: Id of the bank the consent applies to
        expiresAtUtc:
          type: string
          description: Date the consent expires
          format: date-time
        consentData:
          type:
            - 'null'
            - object
          additionalProperties:
            type: string
          description: The consent-data, not generally available.
      additionalProperties: false
      description: Information about the consent that has been obtained
    ConsentStatus:
      enum:
        - unknown
        - created
        - started
        - authorized
        - expired
        - revoked
        - failure
        - awaitingApproval
      type: string
      description: Status of the consent
      x-enumDescriptions:
        unknown: ''
        created: |-
          <summary>
                      Consent session has been created
                      </summary>
        started: |-
          <summary>
                      Consent flow has started
                      </summary>
        authorized: |-
          <summary>
                      Consent has been obtained and is ready to be used
                      </summary>
        expired: |-
          <summary>
                      The consent has expired
                      </summary>
        revoked: |-
          <summary>
                      The consent has been revoked
                      </summary>
        failure: |-
          <summary>
                      Failed to retrieve consent
                      </summary>
        awaitingApproval: |-
          <summary>
                      Consent is being processed
                      </summary>
    CreateAuthorizationResponse:
      type: object
      properties:
        scaStatus:
          type: string
          description: |-
            Status of the SCA.

            **Example:**
            * `received`
            * `psuIdentified`
            * `psuAuthenticated`
            * `scaMethodSelected`
            * `unconfirmed`
            * `started`
            * `finalised`
            * `failed`
            * `exempted`
          example: started
        authorizationId:
          type: string
          description: Resource identification of the related SCA.
          example: auth9000
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentAuthorizationLinks'
      additionalProperties: false
    CreateConsentRequest:
      type: object
      properties:
        bankId:
          type:
            - 'null'
            - string
          description: >-
            Optional unique identifier of the bank you are creating consent for,
            if not specified the user will be asked to select one.

            The unique identifiers can be found through the list bank API call
            (GET /banks).
          example: 89F7F63B-67C0-4F70-A6BE-898BC211DCA0
        channelType:
          allOf:
            - $ref: '#/components/schemas/BankingChannel'
          description: The banking channel.
          example: psd2
        expires:
          type:
            - 'null'
            - string
          description: |-
            The time the consent should expire.
            Defaults to:
              * psd2: 90 days
              * openbanking: no expiration
          format: date-time
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties used for creating consents.
        redirectSettings:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/RedirectSettings'
          description: Contains settings for redirects
        state:
          type:
            - 'null'
            - string
          description: |-
            Can be used by client to keep track of consent flow.
            Will be returned in response to CreateConsent API call and 
            added to return url as a queryparameter if return url is specified.
          example: qwerty
        subscriptionId:
          type:
            - 'null'
            - string
          description: Id of the subscription which this consent will created under.
        resourceGroupName:
          type:
            - 'null'
            - string
          description: >-
            Name of the resource-group which this consent will be organized
            under.
        resourceGroupDisplayName:
          type:
            - 'null'
            - string
          description: >-
            Display name of the resource-group which this consent will be
            organized under.
      additionalProperties: false
    CreateConsentResponse:
      type: object
      properties:
        consentId:
          type: string
          description: The consent id
          example: 1E5EFC3B-635E-4973-A605-41D7F0D6D7B3
        resourceId:
          type: string
          description: Fully qualified resource id of the consent
        redirectUrl:
          type:
            - 'null'
            - string
          description: >-
            Url to redirect the user to.

            Language can be preselected with query parameter (ui-culture) when
            redirecting users.

            Current supported languages are nb (norwegian bokmål) and en
            (english, default).

            Ex: https://google.com?ui-culture=nb
          example: https://google.com
        status:
          allOf:
            - $ref: '#/components/schemas/ConsentStatus'
          description: Status of the created consent
          example: Created
        state:
          type:
            - 'null'
            - string
          description: State from the request
          example: qwerty
      additionalProperties: false
    CreditorReferenceInformation:
      required:
        - reference
      type: object
      properties:
        reference:
          maxLength: 35
          type: string
          description: The actual reference
          example: Text, maximum of 35 characters.
        referenceTypeCode:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/CreditorReferenceTypeCode'
          description: Type of the reference, provided as code
          example: SCOR
        referenceTypeProprietary:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Type of the reference, provided in proprietary encoding
          example: Text, maximum of 35 characters.
        referenceIssuer:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Issuer of the reference
          example: Text, maximum of 35 characters.
      additionalProperties: false
      description: >-
        Reference information provided by the creditor to allow the
        identification of the underlying documents
    CreditorReferenceTypeCode:
      enum:
        - radm
        - rpin
        - fxdr
        - disp
        - puor
        - scor
      type: string
      description: Type of the reference, provided as code
    EntryDetail:
      type: object
      properties:
        references:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionReferences'
          description: References to the transaction.
        creditorId:
          maxLength: 35
          type:
            - 'null'
            - string
          description: >-
            Identification of Creditors, e.g. a SEPA Creditor ID. example:
            Creditor Id 5678
        transactionAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Transaction amount
        amountDetails:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AmountDetails'
          description: Additional information to the transaction amount.
        charges:
          type: array
          items:
            $ref: '#/components/schemas/Charge'
          description: Provides information on the charges.
        currencyExchange:
          type: array
          items:
            $ref: '#/components/schemas/ReportExchangeRate'
          description: Currency exchange information.
        creditor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the creditor if a "Debited" transaction
        creditorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Reference to a creditor account
        debtor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the debtor if a "Credited" transaction
        debtorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Reference to a debtor account
        additionalTransactionInformation:
          type:
            - 'null'
            - string
        remittanceInformationUnstructured:
          type: array
          items:
            type: string
          description: >-
            Array of unstructured remittance info, example: ["Ref Number
            Merchant", "Some Other Text"]
        remittanceInformationStructured:
          type: array
          items:
            $ref: '#/components/schemas/RemittanceInformationStructured'
          description: Structured Remittance information
      additionalProperties: false
      description: Details about a transaction within a batch.
    GenericAccountDto:
      required:
        - identification
        - schemeName
      type: object
      properties:
        identification:
          minLength: 1
          type: string
          description: Account identification.
          example: 123-1234
        schemeName:
          minLength: 1
          type: string
          description: |-
            Name of the identification scheme.
            **Example:**
            * `BBAN`: Basic Bank Account Number.
            * `BGNR`: Bankgirot number.
            * `PGNR`: PlusGirot number.
            * `giro`: Giro Denmark.
          example: BGNR
      additionalProperties: false
      description: Generic account reference.
    GetBulkPaymentResponse:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
        tppMessage:
          type: array
          items:
            $ref: '#/components/schemas/TppMessage'
          description: Messages on operational issues.
        requestedExecutionDate:
          type:
            - 'null'
            - string
          format: date
        debtorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        debtorName:
          type:
            - 'null'
            - string
          description: Debtor name
        debtorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Debtor address
        createdAt:
          type:
            - 'null'
            - string
          format: date-time
        updatedAt:
          type:
            - 'null'
            - string
          format: date-time
        _links:
          allOf:
            - $ref: '#/components/schemas/PagedPaymentInitiationLinks'
        batchBookingPreferred:
          type: boolean
        payments:
          type: array
          items:
            $ref: '#/components/schemas/PaymentLineResponseDto'
      additionalProperties: false
    GetBulkPaymentsResponse:
      type: object
      properties:
        payments:
          type: array
          items:
            $ref: '#/components/schemas/PaymentLinksBulkPaymentResponse'
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
    GetConsentResponse:
      type: object
      properties:
        consentId:
          type: string
          description: The consent id
          example: 1E5EFC3B-635E-4973-A605-41D7F0D6D7B3
        resourceId:
          type: string
          description: Fully qualified resource id of the consent
        status:
          allOf:
            - $ref: '#/components/schemas/ConsentStatus'
          description: Status of the consent
          example: authorized
        additionalData:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ConsentAdditionalData'
          description: Information about the consent that has been obtained
      additionalProperties: false
    GetConsentsResponse:
      type: object
      properties:
        consents:
          type: array
          items:
            $ref: '#/components/schemas/GetConsentResponse'
          description: The consents
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
    GetPaymentResponse:
      required:
        - creditorAccount
        - creditorName
        - instructedAmount
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
        tppMessage:
          type: array
          items:
            $ref: '#/components/schemas/TppMessage'
          description: Messages on operational issues.
        requestedExecutionDate:
          type:
            - 'null'
            - string
          format: date
        debtorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        debtorName:
          type:
            - 'null'
            - string
          description: Debtor name
        debtorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Debtor address
        createdAt:
          type:
            - 'null'
            - string
          format: date-time
        updatedAt:
          type:
            - 'null'
            - string
          format: date-time
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentInitiationLinks'
        endToEndIdentification:
          maxLength: 35
          type:
            - 'null'
            - string
          description: End to end identification
        instructedAmount:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Instructed amount
        creditorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountNumbers'
          description: Creditor account
        creditorAgent:
          pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
          type:
            - 'null'
            - string
          description: BICFI
          example: DNBANOKK
        creditorAgentCountryCode:
          pattern: '[A-Z]{2}'
          type:
            - 'null'
            - string
          description: Country code of the creditor agent.
          example: 'NO'
        creditorAgentClearingSystem:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ClearingSystemDto'
          description: >-
            Information about a clearing system member, which might be required
            for payments to non EEA member states.
        creditorName:
          maxLength: 70
          minLength: 1
          type: string
          description: Creditor name
          example: Ola
        creditorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Creditor address
        remittanceInformationUnstructured:
          maxLength: 140
          type:
            - 'null'
            - string
          description: Unstructured remittance information
          example: message
        remittanceInformationStructured:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/RemittanceInformation'
          description: Structured remittance information
        remittanceInformationStructuredArray:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/RemittanceInformation'
        purposeCode:
          type:
            - 'null'
            - string
          description: ISO 20022 ExternalPurpose1Code
        purposeProprietary:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Purpose in a proprietary form.
        regulatoryReportingAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Amount with currency
        regulatoryReportingCode:
          type:
            - 'null'
            - string
          description: Regulatory reporting code
          example: 26
        regulatoryReportingInformation:
          type:
            - 'null'
            - string
          description: Regulatory reporting info
          example: Rent
        bundleReference:
          type:
            - 'null'
            - string
          description: >-
            Reference that can be used for choosing what payments will be
            bundled together
          example: bundle-id-123456789
        instructionPriority:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/InstructionPriorityCode'
      additionalProperties: false
    HttpVerb:
      enum:
        - get
        - post
        - put
        - delete
      type: string
    IActionResult:
      type: object
      additionalProperties: false
    InitiateBulkPaymentResponse:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentInitiationLinks'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/PaymentReference'
          description: A list of payment references.
      additionalProperties: false
    InitiatePaymentResponse:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
        tppMessage:
          type: array
          items:
            $ref: '#/components/schemas/TppMessage'
          description: Messages on operational issues.
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentInitiationLinks'
      additionalProperties: false
    InstructionPriorityCode:
      enum:
        - normal
        - high
        - urgent
      type: string
      description: >-
        Indictator of the urgency or order of importance that the payment is
        requested processed.
      x-enumDescriptions:
        normal: |-
          <summary>
                      Standard payment with normal priority (D+1).
                      </summary>
        high: |-
          <summary>
                      Standard payment with high priority (D+0).
                      </summary>
        urgent: |-
          <summary>
                      Urgent payment (instant payment).
                      </summary>
    Link:
      type: object
      properties:
        href:
          type: string
          description: Url to a resource
          example: >-
            https://banking.aritma.io/api/accounts/1234/transactions?fromDate=2019-08-24T14:15:22Z
        verb:
          allOf:
            - $ref: '#/components/schemas/HttpVerb'
          description: The http verb the link is accessible through
      additionalProperties: false
    Links:
      type: object
      properties:
        next:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
          description: A link to the next request if available
        previous:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
          description: A link to the previous request if available
      additionalProperties: false
      description: Links
    Money:
      type: object
      properties:
        currency:
          type:
            - 'null'
            - string
          description: The three-letter currency code of the amount - ISO 4217
          example: NOK
        amount:
          pattern: '-?[0-9]{1,14}(\.[0-9]{1,3})?'
          type:
            - 'null'
            - string
          description: >-
            The amount value. Negative amounts are signed by minus. The decimal
            separator is a dot.
                        
            **Example:**

            * 0

            * 154

            * -1.75

            * 349.7

            * 3632.78
          example: 3632.78
      additionalProperties: false
      description: Amount with currency
    PagedPaymentInitiationLinks:
      type: object
      properties:
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
        status:
          allOf:
            - $ref: '#/components/schemas/Link'
        startAuthorization:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
        scaRedirect:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
        next:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
        prev:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
      additionalProperties: false
    PaymentAuthorizationLinks:
      type: object
      properties:
        scaRedirect:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
          description: URL to redirect the PSU to in case of a redirect-based SCA approach.
        scaOauth:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
          description: >-
            URL where the configuration of the authorisation server can be
            retrieved in case of an OAuth 2.0-based authentication process.
          example: https://id.aritma.io
        confirmation:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
          description: >-
            URL to the resource which needs to be updated with an access token
            for an OAuth 2.0-based authentication process.
          example: https://banking.aritma.io/api/payments/1/authorizations/1
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
      additionalProperties: false
    PaymentDeleteResponse:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
      additionalProperties: false
    PaymentInitiationLinks:
      type: object
      properties:
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
        status:
          allOf:
            - $ref: '#/components/schemas/Link'
        startAuthorization:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
        scaRedirect:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Link'
      additionalProperties: false
    PaymentLine:
      required:
        - creditorAccount
        - creditorName
        - instructedAmount
      type: object
      properties:
        endToEndIdentification:
          maxLength: 35
          type:
            - 'null'
            - string
          description: End to end identification
        instructedAmount:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Instructed amount
        creditorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountNumbers'
          description: Creditor account
        creditorAgent:
          pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
          type:
            - 'null'
            - string
          description: BICFI
          example: DNBANOKK
        creditorAgentCountryCode:
          pattern: '[A-Z]{2}'
          type:
            - 'null'
            - string
          description: Country code of the creditor agent.
          example: 'NO'
        creditorAgentClearingSystem:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ClearingSystemDto'
          description: >-
            Information about a clearing system member, which might be required
            for payments to non EEA member states.
        creditorName:
          maxLength: 70
          minLength: 1
          type: string
          description: Creditor name
          example: Ola
        creditorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Creditor address
        remittanceInformationUnstructured:
          maxLength: 140
          type:
            - 'null'
            - string
          description: Unstructured remittance information
          example: message
        remittanceInformationStructured:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/RemittanceInformation'
          description: Structured remittance information
        remittanceInformationStructuredArray:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/RemittanceInformation'
        purposeCode:
          type:
            - 'null'
            - string
          description: >-
            External purpose code (ExternalPurpose1Code from ISO 20022)
                        
            **Example:**

            * SUPP: Payment to a supplier.

            * SALA: Payment of salaries.

            * IPAY: Instant payment.

            * INTC: Intra-company payment.

            * TAXS: Payment of taxes.

            * PENS: Payment of pension.

            * TREA: Treasury operations.

            * CORT: Settlement of a trade, e.g. a foreign exchange deal or a
            securities transaction.


            An example usage of this field is for salary payments. They would
            typically use the purpose code "SALA".
        purposeProprietary:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Purpose in a proprietary form.
        categoryPurposeCode:
          type:
            - 'null'
            - string
          description: >-
            External category purpose code (ExternalCategoryPurpose1Code from
            ISO 20022)


            Supported values are: [

            BONU, CASH, CBLK, CCRD, CORT, DCRD, DIVI, DVPM, EPAY, FCIN, FCOL,

            GP2P, GOVT, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P,

            OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, TAXS, TRAD,

            TREA, VATX, WHLD, SWEP, TOPG, ZABA, VOST, FCDT, CIPC, CONC, CGWV,

            SAVG, CTDF

            ]

            An example usage of this field is for salary payments. They would
            typically use the purpose code "SALA".
        regulatoryReportingAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Amount with currency
        regulatoryReportingCode:
          type:
            - 'null'
            - string
          description: Regulatory reporting code
          example: 26
        regulatoryReportingInformation:
          type:
            - 'null'
            - string
          description: Regulatory reporting info
          example: Rent
        bundleReference:
          type:
            - 'null'
            - string
          description: >-
            Reference that can be used for choosing what payments will be
            bundled together
          example: bundle-id-123456789
        instructionPriority:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/InstructionPriorityCode'
      additionalProperties: false
    PaymentLineResponseDto:
      required:
        - creditorAccount
        - creditorName
        - instructedAmount
      type: object
      properties:
        endToEndIdentification:
          maxLength: 35
          type:
            - 'null'
            - string
          description: End to end identification
        instructedAmount:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Instructed amount
        creditorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountNumbers'
          description: Creditor account
        creditorAgent:
          pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
          type:
            - 'null'
            - string
          description: BICFI
          example: DNBANOKK
        creditorAgentCountryCode:
          pattern: '[A-Z]{2}'
          type:
            - 'null'
            - string
          description: Country code of the creditor agent.
          example: 'NO'
        creditorAgentClearingSystem:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ClearingSystemDto'
          description: >-
            Information about a clearing system member, which might be required
            for payments to non EEA member states.
        creditorName:
          maxLength: 70
          minLength: 1
          type: string
          description: Creditor name
          example: Ola
        creditorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Creditor address
        remittanceInformationUnstructured:
          maxLength: 140
          type:
            - 'null'
            - string
          description: Unstructured remittance information
          example: message
        remittanceInformationStructured:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/RemittanceInformation'
          description: Structured remittance information
        remittanceInformationStructuredArray:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/RemittanceInformation'
        purposeCode:
          type:
            - 'null'
            - string
          description: >-
            External purpose code (ExternalPurpose1Code from ISO 20022)
                        
            **Example:**

            * SUPP: Payment to a supplier.

            * SALA: Payment of salaries.

            * IPAY: Instant payment.

            * INTC: Intra-company payment.

            * TAXS: Payment of taxes.

            * PENS: Payment of pension.

            * TREA: Treasury operations.

            * CORT: Settlement of a trade, e.g. a foreign exchange deal or a
            securities transaction.


            An example usage of this field is for salary payments. They would
            typically use the purpose code "SALA".
        purposeProprietary:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Purpose in a proprietary form.
        categoryPurposeCode:
          type:
            - 'null'
            - string
          description: >-
            External category purpose code (ExternalCategoryPurpose1Code from
            ISO 20022)


            Supported values are: [

            BONU, CASH, CBLK, CCRD, CORT, DCRD, DIVI, DVPM, EPAY, FCIN, FCOL,

            GP2P, GOVT, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P,

            OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, TAXS, TRAD,

            TREA, VATX, WHLD, SWEP, TOPG, ZABA, VOST, FCDT, CIPC, CONC, CGWV,

            SAVG, CTDF

            ]

            An example usage of this field is for salary payments. They would
            typically use the purpose code "SALA".
        regulatoryReportingAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Amount with currency
        regulatoryReportingCode:
          type:
            - 'null'
            - string
          description: Regulatory reporting code
          example: 26
        regulatoryReportingInformation:
          type:
            - 'null'
            - string
          description: Regulatory reporting info
          example: Rent
        bundleReference:
          type:
            - 'null'
            - string
          description: >-
            Reference that can be used for choosing what payments will be
            bundled together
          example: bundle-id-123456789
        instructionPriority:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/InstructionPriorityCode'
        paymentId:
          type:
            - 'null'
            - string
          description: Unique payment identification
        transactionStatus:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment line
          example: pdng
        createdAt:
          type:
            - 'null'
            - string
          format: date-time
        updatedAt:
          type:
            - 'null'
            - string
          format: date-time
      additionalProperties: false
    PaymentLinks:
      type: object
      properties:
        self:
          allOf:
            - $ref: '#/components/schemas/Link'
        status:
          allOf:
            - $ref: '#/components/schemas/Link'
      additionalProperties: false
    PaymentLinksBulkPaymentResponse:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment initiation
          example: A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/TransactionStatus'
          description: Status of the payment
          example: pdng
        tppMessage:
          type: array
          items:
            $ref: '#/components/schemas/TppMessage'
          description: Messages on operational issues.
        requestedExecutionDate:
          type:
            - 'null'
            - string
          format: date
        debtorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        debtorName:
          type:
            - 'null'
            - string
          description: Debtor name
        debtorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Debtor address
        createdAt:
          type:
            - 'null'
            - string
          format: date-time
        updatedAt:
          type:
            - 'null'
            - string
          format: date-time
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentLinks'
      additionalProperties: false
    PaymentParameters:
      type: object
      properties:
        requiredAuthorizations:
          type:
            - 'null'
            - integer
          description: The total number of authorizations required for payments.
          format: int32
          example: 1
        accountingApprovedPayments:
          type:
            - 'null'
            - boolean
          description: If accounting approved payments (RGB) are enabled for payments
      additionalProperties: false
      description: Parameters for payments.
    PaymentProduct:
      enum:
        - creditTransfer
        - directDebit
      type: string
    PaymentReference:
      type: object
      properties:
        paymentId:
          type: string
          description: Id of the payment
          example: p1b6523d427c32efc47ee1f9530
        endToEndIdentification:
          maxLength: 35
          type:
            - 'null'
            - string
          description: End to end identification
      additionalProperties: false
    PaymentRequestBulk:
      required:
        - debtorAccount
      type: object
      properties:
        debtorAccount:
          allOf:
            - $ref: '#/components/schemas/AccountNumbers'
        debtorName:
          type:
            - 'null'
            - string
          description: Debtor name
        debtorAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Address'
          description: Debtor address
        batchBookingPreferred:
          type: boolean
        requestedExecutionDate:
          type:
            - 'null'
            - string
          format: date
        paymentLines:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/PaymentLine'
      additionalProperties: false
    PaymentService:
      enum:
        - payments
        - bulkPayments
      type: string
    PostalAddress:
      type: object
      properties:
        addressLines:
          maxItems: 7
          type: array
          items:
            type: string
          description: >-
            At most seven entries are permitted. May only be used, 

            if none of the structured address elements "streetName",
            "buildingNumber", "postcode" or "townName" is used.
        streetName:
          maxLength: 70
          type:
            - 'null'
            - string
          description: Name of a street or thoroughfare.
          example: River Street
        buildingNumber:
          maxLength: 16
          type:
            - 'null'
            - string
          description: Number that identifies the position of a building on a street.
          example: 12
        postCode:
          maxLength: 16
          type:
            - 'null'
            - string
          description: >-
            Identifier consisting of a group of letters and/or numbers that is
            added to a postal address to assist the sorting of mail.
          example: 12345
        townName:
          maxLength: 35
          type:
            - 'null'
            - string
          description: >-
            Name of a built-up area, with defined boundaries, and a local
            government. Usage Rule: If address lines are not used, this
            attribute is mandatory.
          example: Oslo
        country:
          maxLength: 70
          pattern: '[A-Z]{2}'
          type:
            - 'null'
            - string
          description: >-
            Nation with its own government.Usage Rule: If address lines are not
            used, this attribute is mandatory.
          example: 'NO'
      additionalProperties: false
    PostalAddressDto:
      type: object
      properties:
        country:
          pattern: '[A-Z]{2}'
          type:
            - 'null'
            - string
          description: Country of the postal address.
          example: 'NO'
      additionalProperties: false
      description: Postal address of a party.
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          type:
            - 'null'
            - integer
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
      additionalProperties: {}
    PropType:
      enum:
        - string
        - number
        - integer
        - boolean
        - array
      type: string
      description: The type of the field
    PropertyCondition:
      type: object
      properties:
        property:
          type: string
          description: A property key
        predicate:
          allOf:
            - $ref: '#/components/schemas/PropertyConditionPredicate'
          description: Predicate that must pass
        value:
          type: string
          description: A property value
      additionalProperties: false
      description: >-
        An optional property condition that must be met in order for this
        property to apply
    PropertyConditionPredicate:
      enum:
        - eq
        - lt
        - gt
      type: string
    RedirectSettings:
      type: object
      properties:
        success:
          type:
            - 'null'
            - string
          description: >-
            The url to redirect the user to after a successful consent creation
            flow.

            If not specified the user is redirected to a default landing page
            after successfully completing the flow.
          example: https://www.google.com/search?q=success
        error:
          type:
            - 'null'
            - string
          description: >-
            The url to redirect the user to if something goes wrong.

            If not specified the user is redirected to a default error page if
            something went wrong.
          example: https://www.google.com/search?q=error
      additionalProperties: false
      description: Contains settings for redirects
    ReferredDocumentInformation:
      type: object
      properties:
        typeCode:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/ReferredDocumentTypeCode'
          description: Specifies the type of referred document, provided as code.
          example: CINV
        typeProprietary:
          maxLength: 35
          type:
            - 'null'
            - string
          description: >-
            Specifies the type of referred document, provided in proprietary
            encoding
          example: Text, maximum of 35 characters.
        typeIssuer:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Issuer of the document type
          example: Text, maximum of 35 characters.
        number:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Unique and unambiguous identification of the referred document
          example: Text, maximum of 35 characters.
        relatedDate:
          type:
            - 'null'
            - string
          description: Date associated with the referred document
          format: date-time
          example: '2020-01-01'
      additionalProperties: false
      description: >-
        Set of elements used to identify the documents referred to in the
        remittance information
    ReferredDocumentTypeCode:
      enum:
        - msin
        - cnfa
        - dnfa
        - cinv
        - cren
        - debn
        - hiri
        - sbin
        - cmcn
        - soac
        - disp
        - bold
        - vchr
        - aroi
        - tsut
        - puor
      type: string
      description: Specifies the type of referred document, provided as code
    RefreshConsentRequest:
      type: object
      properties:
        expires:
          type:
            - 'null'
            - string
          description: |-
            The time the consent should expire.
            Defaults to:
              * psd2: 90 days
              * openbanking: no expiration
          format: date-time
        redirectSettings:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/RedirectSettings'
          description: Contains settings for redirects
        state:
          type:
            - 'null'
            - string
          description: |-
            Can be used by client to keep track of consent flow.
            Will be returned in response to CreateConsent API call and 
            added to return url as a queryparameter if return url is specified.
          example: qwerty
      additionalProperties: false
    RemittanceInformation:
      type: object
      properties:
        reference:
          maxLength: 35
          minLength: 1
          type:
            - 'null'
            - string
          description: Reference
          example: 777588823
        referenceType:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Reference type
          example: SCOR
        referenceIssuer:
          maxLength: 35
          type:
            - 'null'
            - string
      additionalProperties: false
      description: Structured remittance information
    RemittanceInformationStructured:
      type: object
      properties:
        remittanceAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: >-
            The remittance amount. May represent either credit note amount, due
            payable amount or the remitted amount
        referredDocumentInformation:
          type: array
          items:
            $ref: '#/components/schemas/ReferredDocumentInformation'
          description: >-
            Set of elements used to identify the documents referred to in the
            remittance information
        creditorReferenceInformation:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/CreditorReferenceInformation'
          description: >-
            Reference information provided by the creditor to allow the
            identification of the underlying documents
        additionalRemittanceInformation:
          type: array
          items:
            type: string
          description: >-
            Additional information to be displayed to the PSU e.g. within
            authorisation processes. This will not be used in related interbank
            payments
      additionalProperties: false
      description: Structured remittance information
    ReportExchangeRate:
      required:
        - exchangeRate
        - sourceCurrency
      type: object
      properties:
        sourceCurrency:
          pattern: '[A-Z]{3}'
          type: string
          description: >-
            Currency from which an amount is to be converted in a currency
            conversion
          example: EUR
        exchangeRate:
          type: number
          description: >-
            Factor used to convert an amount from one currency into another.
            This reflects the price at which one currency was bought with
            another currency
          format: double
        unitCurrency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: >-
            Currency in which the rate of exchange is expressed in a currency
            exchange. In the example 1EUR = xxxCUR, the unit currency is EUR
          example: EUR
        targetCurrency:
          pattern: '[A-Z]{3}'
          type:
            - 'null'
            - string
          description: >-
            Currency into which an amount is to be converted in a currency
            conversion
          example: EUR
        quotationDate:
          type:
            - 'null'
            - string
          description: Date at which an exchange rate is quoted
          format: date-time
        contractId:
          type:
            - 'null'
            - string
          description: >-
            Unique identification to unambiguously identify the foreign exchange
            contract
      additionalProperties: false
    ResourceMetadataDto:
      type: object
      properties:
        subscriptionId:
          type: string
          description: Id of the subscription
          example: foo
        resourceGroupId:
          type: string
          description: Id of the resource-group
          example: company-x
        resourceId:
          type: string
          description: Fully qualified resource uri.
          example: >-
            /subscriptions/foo/resource-groups/company-x/providers/aritma.openbanking/accounts/1234
      additionalProperties: false
      description: Metadata about the resource.
    SelectPsuAuthenticationMethod:
      type: object
      properties:
        authenticationMethodId:
          type:
            - 'null'
            - string
          description: Identification used for later authentication method selection.
        authenticationMethodAcrValues:
          type:
            - 'null'
            - string
          description: Acr values used for later authentication method selection.
      additionalProperties: false
    SigningBasket:
      required:
        - paymentIds
      type: object
      properties:
        paymentIds:
          minItems: 1
          type: array
          items:
            type: string
          description: Id of the payments
          example:
            - A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
      additionalProperties: false
    SigningBasketResponse:
      type: object
      properties:
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/BasketTransactionStatus'
          description: The "most negative" status of all the payments
          example: actc
        basketId:
          type: string
          description: Id of the signing basket
          example: 09ACBC7B-15E1-4E4A-B2A0-551345EB4360
        paymentIds:
          type: array
          items:
            type: string
          description: Id of the payments
          example:
            - A30D7108-A584-4C32-95ED-8FF4BB5A7C2C
        consentIds:
          type: array
          items:
            type: string
          description: Id of the consents
          example:
            - 1E5EFC3B-635E-4973-A605-41D7F0D6D7B3
        _links:
          allOf:
            - $ref: '#/components/schemas/PaymentInitiationLinks'
      additionalProperties: false
    SigningBasketStatusResponse:
      type: object
      properties:
        transactionStatus:
          allOf:
            - $ref: '#/components/schemas/BasketTransactionStatus'
          description: The "most negative" status of all the payments
          example: actc
      additionalProperties: false
    StatusType:
      enum:
        - enabled
        - deleted
        - blocked
      type: string
    TppMessage:
      required:
        - category
        - code
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/TppMessageCategory'
          description: TPP message category.
        code:
          minLength: 1
          type: string
          description: Code of the TPP message.
          example: AC03
        message:
          type:
            - 'null'
            - string
          description: Additional explaining text.
      additionalProperties: false
    TppMessageCategory:
      enum:
        - error
        - warning
      type: string
    Transaction:
      type: object
      properties:
        transactionId:
          type: string
          description: Id of the transaction
          example: DEAF96E4-5063-46D9-89D4-E32A8E51994C
        accountId:
          type: string
          description: Account id used to retrieve the transaction
          example: '1234'
        entryReference:
          type:
            - 'null'
            - string
          description: Entry reference of the transaction
          example: 123456789
        references:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionReferences'
          description: References to the transaction.
        valueDate:
          type:
            - 'null'
            - string
          description: |-
            Date at which the assets become available or cease to be available,
            could be an expected date if state is `pending`.
          format: date-time
          example: '2025-10-25T22:20:31.8361914+00:00'
        bookingDate:
          type:
            - 'null'
            - string
          description: Booking date of the transaction
          format: date-time
          example: '2025-10-26T07:20:31.8361914+00:00'
        transactionAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Transaction amount
        amountDetails:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AmountDetails'
          description: Additional information to the transaction amount.
        currencyExchange:
          type: array
          items:
            $ref: '#/components/schemas/ReportExchangeRate'
          description: Currency exchange information.
        charge:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Charge'
          description: Sum of all charges in the transaction
        creditor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the creditor if a "Debited" transaction
        creditorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        debtor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the debtor if a "Credited" transaction
        debtorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        remittanceInformationUnstructured:
          type: array
          items:
            type: string
          description: >-
            Array of unstructured remittance info, example: ["Ref Number
            Merchant", "Some Other Text"]
        remittanceInformationStructured:
          type: array
          items:
            $ref: '#/components/schemas/RemittanceInformationStructured'
          description: Structured Remittance information
        purposeCode:
          type:
            - 'null'
            - string
          description: External purpose code (ExternalPurpose1Code from ISO 20022)
          example: SALA
        purposeProprietary:
          type:
            - 'null'
            - string
          description: Proprietary purpose
        bankTransactionCode:
          type:
            - 'null'
            - string
          description: Bank transaction code as used by the ASPSP (ISO 20022)
        bankTransactionCodeProprietary:
          type:
            - 'null'
            - string
          description: Proprietary bank transaction code as used by the ASPSP
        additionalInformation:
          type:
            - 'null'
            - string
          description: Additional transaction related information from the ASPSP to the PSU
        entryDetailsCount:
          type:
            - 'null'
            - integer
          description: A count of how many entry details that exist.
          format: int32
      additionalProperties: false
      description: A single transaction
    TransactionDetail:
      type: object
      properties:
        transactionId:
          type: string
          description: Id of the transaction
          example: DEAF96E4-5063-46D9-89D4-E32A8E51994C
        accountId:
          type: string
          description: Account id used to retrieve the transaction
          example: '1234'
        entryReference:
          type:
            - 'null'
            - string
          description: Entry reference of the transaction
          example: 123456789
        references:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionReferences'
          description: References to the transaction.
        valueDate:
          type:
            - 'null'
            - string
          description: |-
            Date at which the assets become available or cease to be available,
            could be an expected date if state is `pending`.
          format: date-time
          example: '2025-10-25T22:20:31.8361914+00:00'
        bookingDate:
          type:
            - 'null'
            - string
          description: Booking date of the transaction
          format: date-time
          example: '2025-10-26T07:20:31.8361914+00:00'
        transactionAmount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Transaction amount
        amountDetails:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AmountDetails'
          description: Additional information to the transaction amount.
        currencyExchange:
          type: array
          items:
            $ref: '#/components/schemas/ReportExchangeRate'
          description: Currency exchange information.
        charge:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/Charge'
          description: Sum of all charges in the transaction
        creditor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the creditor if a "Debited" transaction
        creditorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        debtor:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/TransactionParty'
          description: Name and information about the debtor if a "Credited" transaction
        debtorAccount:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: Account reference
        remittanceInformationUnstructured:
          type: array
          items:
            type: string
          description: >-
            Array of unstructured remittance info, example: ["Ref Number
            Merchant", "Some Other Text"]
        remittanceInformationStructured:
          type: array
          items:
            $ref: '#/components/schemas/RemittanceInformationStructured'
          description: Structured Remittance information
        purposeCode:
          type:
            - 'null'
            - string
          description: External purpose code (ExternalPurpose1Code from ISO 20022)
          example: SALA
        purposeProprietary:
          type:
            - 'null'
            - string
          description: Proprietary purpose
        bankTransactionCode:
          type:
            - 'null'
            - string
          description: Bank transaction code as used by the ASPSP (ISO 20022)
        bankTransactionCodeProprietary:
          type:
            - 'null'
            - string
          description: Proprietary bank transaction code as used by the ASPSP
        additionalInformation:
          type:
            - 'null'
            - string
          description: Additional transaction related information from the ASPSP to the PSU
        entryDetailsCount:
          type:
            - 'null'
            - integer
          description: A count of how many entry details that exist.
          format: int32
        entryDetails:
          type: array
          items:
            $ref: '#/components/schemas/EntryDetail'
          description: Details about transactions within a batch.
        _links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: Links
      additionalProperties: false
      description: A single transaction detail
    TransactionDetailsResponse:
      type: object
      properties:
        transactionDetails:
          allOf:
            - $ref: '#/components/schemas/TransactionDetail'
          description: Transaction details
      additionalProperties: false
      description: Transaction details response
    TransactionParty:
      type: object
      properties:
        name:
          maxLength: 140
          type:
            - 'null'
            - string
          description: Name of the party.
          example: Credit AS
        postalAddress:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/PostalAddress'
          description: Postal Address of the party.
      additionalProperties: false
    TransactionReferences:
      type: object
      properties:
        endToEndIds:
          type: array
          items:
            type: string
          description: EndToEnd ids for the transaction
        instructionId:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Instruction Identification from pain.001 in outgoing payments
          example: 123456789
        accountServicerReference:
          maxLength: 35
          type:
            - 'null'
            - string
          description: >-
            Unique reference, as assigned by the account servicing institution,
            to unambiguously identify the instruction.

            Also known as "Archive Reference".
          example: 123456789
        mandateId:
          maxLength: 35
          type:
            - 'null'
            - string
          description: Direct debit related mandate.
          example: 123456789
        checkNumber:
          maxLength: 35
          type:
            - 'null'
            - string
          description: >-
            Unique and unambiguous identifier for a cheque as assigned by the
            agent.
          example: 123456789
      additionalProperties: false
      description: References to the transaction.
    TransactionSource:
      enum:
        - default
        - creditDebitNotification
        - statement
      type: string
      x-enumDescriptions:
        default: |-
          <summary>
                      Will give transactions only from Camt.53. Specifying this value is the same as omitting the field or choosing statement
                      </summary>
        creditDebitNotification: |-
          <summary>
                      Notifications are files usually delivered from the bank multiple times a day,
                      and contains comprehensive information on transactions (Filetype : Camt.54)
                      </summary>
        statement: |-
          <summary>
                      Statements are files usually delivered from the bank one time a day,
                      at the end of the day contains information on transactions (Filetype : Camt.53)
                      </summary>
    TransactionStatus:
      enum:
        - accc
        - accp
        - acsc
        - acsp
        - actc
        - acwc
        - acwp
        - rcvd
        - pdng
        - rjct
        - canc
        - acfc
        - patc
        - part
      type: string
      x-enumDescriptions:
        accc: |-
          <summary>
                      `AcceptedSettlementCompleted` - Settlement on the creditor account has been completed.
                      </summary>
        accp: |-
          <summary>
                      `AcceptedCustomerProfile` - Preceding check of technical validation was successful. Customer profile check was also successful.
                      </summary>
        acsc: |-
          <summary>
                      `AcceptedSettlementCompleted` - Settlement on the debtor account has been completed.
                      </summary>
          <remarks>
                      Usage: this can be used by the first agent to report to the debtor that the transaction has been completed.
                      Warning: this status is provided for transaction status reasons, not for financial information.
                      It can only be used after bilateral agreement.
                      </remarks>
        acsp: |-
          <summary>
                      `AcceptedSettlementInProcess` - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
                      </summary>
        actc: |-
          <summary>
                      `AcceptedTechnicalValidation` - Authentication and syntactical and semantical validation are successful.
                      </summary>
        acwc: |-
          <summary>
                      `AcceptedWithChange` - Instruction is accepted but a change will be made, such as date or remittance not sent.
                      </summary>
        acwp: |-
          <summary>
                      `AcceptedWithoutPosting` - Payment instruction included in the credit transfer is accepted without being posted to the creditor customers account.
                      </summary>
        rcvd: |-
          <summary>
                      `Received` - Payment initiation has been received by the receiving agent.
                      </summary>
        pdng: |-
          <summary>
                      `Pending` - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
                      </summary>
        rjct: |-
          <summary>
                      `Rejected` - Payment initiation or individual transaction included in the payment initiation has been rejected.
                      </summary>
        canc: |-
          <summary>
                      `Cancelled` - Payment initiation has been cancelled before execution
                      </summary>
        acfc: |-
          <summary>
                      `AcceptedFundsChecked` - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive .
                      </summary>
        patc: |-
          <summary>
                      `PartiallyAcceptedTechnicalCorrect` - The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.
                      </summary>
        part: |-
          <summary>
                      `PartiallyAccepted` - A number of transactions have been accepted, whereas another number of transactions have not yet achieved `accepted` status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
                      </summary>
    TransactionType:
      enum:
        - credit
        - debit
      type: string
    TransactionsResponse:
      type: object
      properties:
        account:
          type: 'null'
          allOf:
            - $ref: '#/components/schemas/AccountReference'
          description: The account
        transactions:
          allOf:
            - $ref: '#/components/schemas/AccountReport'
          description: The transactions
      additionalProperties: false
      description: Transactions response
  securitySchemes:
    Api access:
      type: oauth2
      flows:
        password:
          tokenUrl: https://id.dev.aritma.io/connect/token
          scopes:
            services.banking: Grants access to banking service
            api: Grants client access to the api
        clientCredentials:
          tokenUrl: https://id.dev.aritma.io/connect/token
          scopes:
            services.banking: Grants access to banking service
            api: Grants client access to the api
    User access:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.dev.aritma.io/connect/authorize
          tokenUrl: https://id.dev.aritma.io/connect/token
          scopes:
            services.banking: Grants access to banking service
tags:
  - name: Accounts
    description: Access account information.
  - name: Banks
    description: Access information about the available banks.
  - name: Consents
    description: >-
      Obtaining a consent is the first thing you need to do in order to access
      bank information.
                  
      Start by sending a request to the create consent endpoint which will
      return a link you can redirect the user to.

      When the user visits the link, we will gather the necessary information
      needed to obtain a consent linked to the chosen bank.
                  
      When a consent has been obtained you can use it to access data through the
      available endpoints,

      keep in mind that a consent can potentially be withdrawn by the user at
      any point.
  - name: Payments
  - name: SigningBaskets
    description: >-
      Signing baskets are short-lived vessels used for authorizing several
      payments with one SCA operation.
