Spare Transaction API

The Transaction API from Spare — 5 operation(s) for transaction.

OpenAPI Specification

spare-transaction-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Information Account Transaction API
  description: Spare account information API documentation
  termsOfService: https://terms.tryspare.com/en
  contact:
    name: Spare Technologies WLL.
    email: hello@tryspare.com
  license:
    name: Spare Technologies WLL.
  version: '1.0'
security:
- Bearer: []
tags:
- name: Transaction
paths:
  /api/v1.0/ais/Transaction/Get:
    get:
      tags:
      - Transaction
      summary: Get transaction details
      description: "**Unique resource name :** ais.v1.transaction.get\n            \n**Important!:**\n            \nThe permissions bellow are required on the consent:\n- `ReadTransactionsBasic`\n- `ReadTransactionsDetail`\n- `ReadTransactionsDebits`\n- `ReadTransactionsCredits`"
      parameters:
      - name: id
        in: query
        description: Transaction id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionDetailsResponseModelApiResponse'
        '400':
          description: '- If transaction id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If transaction does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Transaction/List:
    post:
      tags:
      - Transaction
      summary: List transactions
      description: "**Unique resource name :** ais.v1.transaction.list\n            \n**Important!:**\n            \nThe permissions bellow are required on the consent:\n- ReadTransactionsBasic\n- ReadTransactionsDetail\n- ReadTransactionsDebits\n- ReadTransactionsCredits"
      parameters:
      - name: consentId
        in: query
        description: Consent id
        required: true
        schema:
          type: string
          format: uuid
      - name: accountId
        in: query
        description: Bank account id
        required: true
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: '1'
      - name: perPage
        in: query
        description: Number of items per page maximum allow is 200 per page
        schema:
          type: integer
          format: int32
          default: '20'
      requestBody:
        description: Filter model
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: '- If consent id is not valid

            - If filter model is not valid

            - If accountId is null or invalid UUID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If consent does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v1.0/ais/Transaction/Salaries:
    get:
      tags:
      - Transaction
      summary: Get account salary
      description: '**Unique resource name :** ais.v1.transaction.salaries'
      parameters:
      - name: accountId
        in: query
        description: Account id
        required: true
        schema:
          type: string
          format: uuid
      - name: fromBookingDateTime
        in: query
        description: From booking date time
        schema:
          type: string
          format: date-time
      - name: toBookingDateTime
        in: query
        description: To booking date time
        schema:
          type: string
          format: date-time
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalaryModelIEnumerableApiResponse'
        '400':
          description: '- If accountId is null or invalid UUID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If account not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v2.0/ais/Transaction/Get:
    get:
      tags:
      - Transaction
      summary: Get transaction details for long-lived consent
      description: "**Unique resource name :** ais.v2.transaction.get\r\n            \r\n**Important!:**\r\n            \r\nThe permissions below are required on the consent:\r\n- `ReadTransactionsBasic`\r\n- `ReadTransactionsDetail`\r\n- `ReadTransactionsDebits`\r\n- `ReadTransactionsCredits`"
      parameters:
      - name: id
        in: query
        description: Transaction id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionDetailsResponseModelApiResponse'
        '400':
          description: '- If transaction id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If transaction does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
  /api/v2.0/ais/Transaction/List:
    post:
      tags:
      - Transaction
      summary: List transactions for long-lived consent
      description: "**Unique resource name :** ais.v2.transaction.list\r\n            \r\n**Important!:**\r\n            \r\nThe permissions below are required on the consent:\r\n- ReadTransactionsBasic\r\n- ReadTransactionsDetail\r\n- ReadTransactionsDebits\r\n- ReadTransactionsCredits"
      parameters:
      - name: consentId
        in: query
        description: Consent id
        required: true
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: '1'
      - name: perPage
        in: query
        description: Number of items per page maximum allow is 200 per page
        schema:
          type: integer
          format: int32
          default: '20'
      - name: accountId
        in: query
        description: Bank account id
        schema:
          type: string
          format: uuid
      requestBody:
        description: Filter model
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/TransactionFilterModel'
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponseModelIEnumerablePagesModelMetaApiResponse'
        '400':
          description: "- If consent id is not valid\r\n- If a filter model is not valid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If consent does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
components:
  schemas:
    SalaryModelIEnumerableApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/SalaryModel'
          nullable: true
      additionalProperties: false
    AmountResponseModel:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        amount:
          type: number
          format: double
          nullable: true
        chargeIncluded:
          type: boolean
          nullable: true
      additionalProperties: false
    TransactionProprietaryBankTransactionCodeModel:
      type: object
      properties:
        issuer:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
      additionalProperties: false
    ObTransactionStatus:
      enum:
      - BOOKED
      - PENDING
      - INTERIM_PENDING
      - REJECTED
      type: string
    SubAccountsResponseModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        scheme:
          type: string
          nullable: true
        identification:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
      additionalProperties: false
    FilterOrder:
      enum:
      - ASCENDING
      - DESCENDING
      type: string
    ApiError:
      enum:
      - INVALID_DATA
      - INVALID_SIGNATURE
      - RESOURCE_LOCKED
      - COUNTRY_NOT_FOUND
      - CURRENCY_NOT_FOUND
      - PROVIDER_NOT_FOUND
      - CONNECTION_NOT_FOUND
      - INSUFFICIENT_CONSENT_PERMISSIONS
      - CONSENT_EXPIRED
      - CONSENT_REVOKED
      - CONSENT_UNAUTHORIZED
      - CONSENT_NOT_FOUND
      - RISK_REPORT_NOT_FOUND
      - ACCOUNT_INFORMATION_REPORT_NOT_FOUND
      - MULTIPLE_CURRENCY_NOT_ALLOWED
      - MULTIPLE_CONSENT_DATE_NOT_ALLOWED
      - PAYMENT_NOT_FOUND
      - CONSENT_REJECTED
      - PAYMENT_REQUEST_NOT_FOUND
      - CUSTOMER_NOT_FOUND
      - CUSTOMER_ALREADY_EXISTS
      - BANK_ACCOUNT_NOT_FOUND
      - SERVER_ERROR
      - PROVIDER_CONNECTION_FAILURE
      - TRANSACTION_NOT_FOUND
      - ACCOUNT_INFORMATION_ACCESS_REQUEST_NOT_FOUND
      - CONSENT_REVOCATION_FAILED
      - CONSENT_REVOKED_OR_EXPIRED
      - SUBSCRIPTION_EXPIRED
      - NOT_SUBSCRIBED_TO_SERVICE
      - BENEFICIARY_NOT_FOUND
      - PARTIES_NOT_FOUND
      - DIRECT_DEBIT_NOT_FOUND
      - SCHEDULED_PAYMENT_NOT_FOUND
      - DEBTOR_ACCOUNT_NOT_FOUND
      - CREDITOR_ACCOUNT_NOT_FOUND
      - UNAUTHORIZED_IP_ADDRESS
      type: string
    TransactionResponseModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        transactionReference:
          type: string
          nullable: true
        localTimeZone:
          type: string
          nullable: true
        transactionDateTime:
          type: string
          format: date-time
          nullable: true
        subTransactionType:
          type: string
          nullable: true
        transactionType:
          type: string
          nullable: true
        flags:
          type: array
          items:
            type: string
          nullable: true
        paymentModes:
          type: string
          nullable: true
        balance:
          $ref: '#/components/schemas/TransactionBalanceModel'
        transactionMutability:
          type: string
          nullable: true
        transactionInformation:
          type: string
          nullable: true
        statementReference:
          type: string
          nullable: true
        creditDebitIndicator:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        bookingDateTime:
          type: string
          format: date
          nullable: true
        valueDateTime:
          type: string
          format: date
          nullable: true
        addressLine:
          type: string
          nullable: true
        amount:
          $ref: '#/components/schemas/TransactionAmountResponseModel'
        chargeAmount:
          $ref: '#/components/schemas/AmountResponseModel'
        billDetails:
          $ref: '#/components/schemas/BillDetailsModel'
        currencyExchange:
          $ref: '#/components/schemas/TransactionCurrencyExchangeResponseModel'
        bankTransactionCode:
          $ref: '#/components/schemas/TransactionBankCodeModel'
        proprietaryBankTransactionCode:
          $ref: '#/components/schemas/TransactionProprietaryBankTransactionCodeModel'
        merchantDetails:
          $ref: '#/components/schemas/TransactionMerchantDetailsModel'
        subCategoryName:
          type: string
          nullable: true
        categoryCode:
          type: string
          nullable: true
        categoryName:
          type: string
          nullable: true
      additionalProperties: false
    ServicerAddressResponseModel:
      type: object
      properties:
        addressType:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        subDepartment:
          type: string
          nullable: true
        addressLine:
          type: string
          nullable: true
        streetName:
          type: string
          nullable: true
        buildingNumber:
          type: string
          nullable: true
        postalCode:
          type: string
          nullable: true
        townName:
          type: string
          nullable: true
        countrySubDivision:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        shortAddress:
          type: string
          nullable: true
        unitNumber:
          type: number
          format: double
          nullable: true
        secondaryNumber:
          type: string
          nullable: true
        district:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
      additionalProperties: false
    ObjectApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          nullable: true
      additionalProperties: false
    ObTransactionProperty:
      enum:
      - BOOKING_DATE
      - STATUS
      - TYPE
      - MERCHANT_NAME
      - MERCHANT_CATEGORY_CODE
      type: string
    TransactionResponseModelIEnumerablePagesModelMetaApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionResponseModel'
          nullable: true
        meta:
          $ref: '#/components/schemas/PagesModel'
      additionalProperties: false
    TransactionDetailsResponseModelApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        data:
          $ref: '#/components/schemas/TransactionDetailsResponseModel'
      additionalProperties: false
    BalanceLocalExchangeModel:
      type: object
      properties:
        sourceCurrency:
          type: string
          nullable: true
        targetCurrency:
          type: string
          nullable: true
        rate:
          type: number
          format: double
        date:
          type: string
          format: date
        value:
          type: number
          format: double
      additionalProperties: false
    ServicerResponseModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        address:
          $ref: '#/components/schemas/ServicerAddressResponseModel'
        scheme:
          type: string
          nullable: true
        identification:
          type: string
          nullable: true
      additionalProperties: false
    ServicerAddressModel:
      type: object
      properties:
        addressType:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        subDepartment:
          type: string
          nullable: true
        addressLine:
          type: string
          nullable: true
        streetName:
          type: string
          nullable: true
        buildingNumber:
          type: string
          nullable: true
        postalCode:
          type: string
          nullable: true
        townName:
          type: string
          nullable: true
        countrySubDivision:
          type: string
          nullable: true
        countryName:
          type: string
          nullable: true
        shortAddress:
          type: string
          nullable: true
        unitNumber:
          type: number
          format: double
          nullable: true
        secondaryNumber:
          type: string
          nullable: true
        district:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
      additionalProperties: false
    BankAccountResponseModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        currency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        servicer:
          $ref: '#/components/schemas/ServicerResponseModel'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/SubAccountsResponseModel'
          nullable: true
        status:
          type: string
          nullable: true
        statusUpdatedDateTime:
          type: string
          format: date-time
          nullable: true
        type:
          type: string
          nullable: true
        subType:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        openingDate:
          type: string
          format: date-time
          nullable: true
        maturityDate:
          type: string
          format: date-time
          nullable: true
      additionalProperties: false
    TransactionMerchantDetailsModel:
      type: object
      properties:
        categoryCode:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        merchantId:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
    TransactionAmountResponseModel:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        localExchange:
          $ref: '#/components/schemas/BalanceLocalExchangeModel'
        amount:
          type: number
          format: double
          nullable: true
        chargeIncluded:
          type: boolean
          nullable: true
      additionalProperties: false
    TransactionCurrencyExchangeResponseModel:
      type: object
      properties:
        sourceCurrency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        targetCurrency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        exchangeRate:
          type: number
          format: double
          nullable: true
        unitCurrency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        contractIdentification:
          type: string
          nullable: true
        quotationDate:
          type: string
          format: date
          nullable: true
        instructedAmount:
          $ref: '#/components/schemas/AmountResponseModel'
      additionalProperties: false
    TransactionFilterModel:
      type: object
      properties:
        fromBookingDateTime:
          type: string
          format: date-time
          nullable: true
        toBookingDateTime:
          type: string
          format: date-time
          nullable: true
        status:
          $ref: '#/components/schemas/ObTransactionStatus'
        type:
          $ref: '#/components/schemas/ObTransactionType'
        searchBy:
          $ref: '#/components/schemas/ObTransactionProperty'
        searchKeyWord:
          maxLength: 100
          type: string
          nullable: true
        orderBy:
          $ref: '#/components/schemas/ObTransactionProperty'
        order:
          $ref: '#/components/schemas/FilterOrder'
      additionalProperties: false
    TransactionDetailsResponseModel:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/BankAccountResponseModel'
        creditorAgent:
          $ref: '#/components/schemas/ServicerModel'
        debtorAgent:
          $ref: '#/components/schemas/ServicerModel'
        deborAccount:
          $ref: '#/components/schemas/SubAccountsResponseModel'
        creditorAccount:
          $ref: '#/components/schemas/SubAccountsResponseModel'
        id:
          type: string
          format: uuid
        transactionReference:
          type: string
          nullable: true
        localTimeZone:
          type: string
          nullable: true
        transactionDateTime:
          type: string
          format: date-time
          nullable: true
        subTransactionType:
          type: string
          nullable: true
        transactionType:
          type: string
          nullable: true
        flags:
          type: array
          items:
            type: string
          nullable: true
        paymentModes:
          type: string
          nullable: true
        balance:
          $ref: '#/components/schemas/TransactionBalanceModel'
        transactionMutability:
          type: string
          nullable: true
        transactionInformation:
          type: string
          nullable: true
        statementReference:
          type: string
          nullable: true
        creditDebitIndicator:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        bookingDateTime:
          type: string
          format: date
          nullable: true
        valueDateTime:
          type: string
          format: date
          nullable: true
        addressLine:
          type: string
          nullable: true
        amount:
          $ref: '#/components/schemas/TransactionAmountResponseModel'
        chargeAmount:
          $ref: '#/components/schemas/AmountResponseModel'
        billDetails:
          $ref: '#/components/schemas/BillDetailsModel'
        currencyExchange:
          $ref: '#/components/schemas/TransactionCurrencyExchangeResponseModel'
        bankTransactionCode:
          $ref: '#/components/schemas/TransactionBankCodeModel'
        proprietaryBankTransactionCode:
          $ref: '#/components/schemas/TransactionProprietaryBankTransactionCodeModel'
        merchantDetails:
          $ref: '#/components/schemas/TransactionMerchantDetailsModel'
        subCategoryName:
          type: string
          nullable: true
        categoryCode:
          type: string
          nullable: true
        categoryName:
          type: string
          nullable: true
      additionalProperties: false
    SalaryModel:
      type: object
      properties:
        accountId:
          type: string
          format: uuid
        month:
          type: string
          nullable: true
        amount:
          type: number
          format: double
        currency:
          type: string
          nullable: true
      additionalProperties: false
    TransactionBankCodeModel:
      type: object
      properties:
        subCode:
          type: string
          nullable: true
        domain:
          type: string
          nullable: true
        domainCode:
          type: string
          nullable: true
        family:
          type: string
          nullable: true
        familyCode:
          type: string
          nullable: true
        subFamily:
          type: string
          nullable: true
        subFamilyCode:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
      additionalProperties: false
    TransactionBalanceModel:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyResponseModel'
        creditDebitIndicator:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        amount:
          type: number
          format: double
          nullable: true
        chargeIncluded:
          type: boolean
          nullable: true
      additionalProperties: false
    CurrencyResponseModel:
      required:
      - englishName
      - iso4117Code
      type: object
      properties:
        id:
          type: string
          format: uuid
        englishName:
          maxLength: 50
          minLength: 1
          type: string
        arabicName:
          maxLength: 50
          type: string
          nullable: true
        iso4117Code:
          maxLength: 3
          minLength: 1
          type: string
        iso4117Number:
          maxLength: 4
          type: string
          nullable: true
      additionalProperties: false
    PagesModel:
      type: object
      properties:
        currentPageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        totalNumberOfPages:
          type: integer
          format: int32
      additionalProperties: false
    ObTransactionType:
      enum:
      - CREDIT
      - DEBIT
      type: string
    BillDetailsModel:
      type: object
      properties:
        billerId:
          type: string
          nullable: true
        billNumber:
          type: string
          nullable: true
        billPaymentType:
          type: string
          nullable: true
      additionalProperties: false
    ServicerModel:
      type: object
      properties:
        scheme:
          type: string
          nullable: true
        identification:
          type: string
          nullable: true
        address:
          $ref: '#/components/schemas/ServicerAddressModel'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter into field the word 'Bearer' followed by a space and JWT
      name: Authorization
      in: header