Leo1 student otp API

The student otp API from Leo1 — 3 operation(s) for student otp.

OpenAPI Specification

leo1-student-otp-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: leofees_backend api student otp API
  version: version
  description: General system endpoints for the API.
tags:
- name: student otp
paths:
  /api/v1/student_otp/send_student_otp:
    post:
      tags:
      - student otp
      summary: Send Student Otp
      operationId: send_student_otp_api_v1_student_otp_send_student_otp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendStudentOTPRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/student_otp/verify_student_otp:
    post:
      tags:
      - student otp
      summary: Verify Student Otp
      operationId: verify_student_otp_api_v1_student_otp_verify_student_otp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyStudentOTPRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /api/v1/student_otp/payment_otp_verification_required:
    post:
      tags:
      - student otp
      summary: Payment Otp Verification Required
      operationId: payment_otp_verification_required_api_v1_student_otp_payment_otp_verification_required_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentOTPVerificationRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    VerifyStudentOTPRequest:
      title: VerifyStudentOTPRequest
      required:
      - mobile_number
      - otp
      type: object
      properties:
        mobile_number:
          title: Mobile Number
          type: string
          description: Mobile number is required
        otp:
          title: Otp
          type: integer
          description: OTP is required
    SendStudentOTPRequest:
      title: SendStudentOTPRequest
      required:
      - mobile_number
      - amount
      type: object
      properties:
        mobile_number:
          title: Mobile Number
          type: string
          description: Mobile number is required
        amount:
          title: Amount
          type: integer
          description: Transaction amount is required
    PaymentOTPVerificationRequest:
      title: PaymentOTPVerificationRequest
      required:
      - institute_id
      - payment_type
      type: object
      properties:
        institute_id:
          title: Institute Id
          type: integer
          description: Institute Id is required
        payment_type:
          title: Payment Type
          type: string
          description: Payment type is required
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: secret-key