openapi: 3.1.0
info:
  title: AbaNinja AbaNet API
  version: 3.0.0
  x-domain-id: abanet
servers:
  - url: https://api.abaninja.ch
    description: The AbaNinja API server
tags:
  - name: networks
    description: Manage abanet networks
    x-displayName: AbaNet Networks
security:
  - ApiToken: []
paths:
  /accounts/{accountUuid}/abanet/v2/connection/status:
    get:
      tags:
        - networks
      summary: Check AbaNet status
      description: Check the connection status of AbaNet
      operationId: abanet_list_status
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                allOf:
                  - description: The response format of most endpoints for successful requests
                    required:
                      - data
                      - message
                      - status
                    properties:
                      data:
                        title: data
                      message:
                        title: message
                        type: string
                      status:
                        title: status
                        description: HTTP status code
                        type: integer
                      meta:
                        title: meta
                        type:
                          - object
                          - 'null'
                    type: object
                  - properties:
                      data:
                        title: AbaNet Connection Status Resource
                        properties:
                          isValid:
                            type: boolean
                          onboardingLink:
                            type:
                              - string
                              - 'null'
                        type: object
                      status:
                        example: 200
                    type: object
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/customers
      x-legacy-operation-id: 596a9bc6c83284b2b39c18e24a965a70
      x-required-scopes:
        - customers
  /accounts/{accountUuid}/abanet/v2/networks/{networkUuid}:
    get:
      tags:
        - networks
      summary: Get AbaNet network
      description: Get a single AbaNet network
      operationId: abanet_get_networks
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: networkUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                allOf:
                  - description: The response format of most endpoints for successful requests
                    required:
                      - data
                      - message
                      - status
                    properties:
                      data:
                        title: data
                      message:
                        title: message
                        type: string
                      status:
                        title: status
                        description: HTTP status code
                        type: integer
                      meta:
                        title: meta
                        type:
                          - object
                          - 'null'
                    type: object
                  - properties:
                      data:
                        title: Network Resource
                        properties:
                          uuid:
                            type: string
                            format: uuid
                          name:
                            type: string
                          contract:
                            type:
                              - string
                              - 'null'
                          type:
                            type: string
                            enum:
                              - receiver
                              - sender
                        type: object
                      status:
                        example: 200
                    type: object
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                allOf:
                  - description: The response format of most endpoints for erronous requests
                    required:
                      - detail
                      - type
                      - message
                      - status
                    properties:
                      detail:
                        title: details
                      type:
                        title: type
                        type: string
                      requestUuid:
                        title: requestUuid
                        type: string
                        format: uuid
                      path:
                        title: path
                        type: string
                      message:
                        title: message
                        type:
                          - string
                          - 'null'
                      status:
                        title: status
                        description: HTTP status code
                        type: integer
                    type: object
                  - properties: {}
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/customers
      x-legacy-operation-id: 3c6dc42ed215feb50bd2c31d547eb91e
      x-required-scopes:
        - customers
components:
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token authentication. Create tokens in Settings > API Token.
