eLoad API - OpenAPI Specification

openapi: 3.0.0
info:
  title: eLoad API
  version: 1.0.0
  description: |
    The eLoad API provides services for transaction and payment processing, including access to error codes, transaction management, and account handling.
    This API is designed to allow seamless integration with the eLoad service for various transaction-related operations.
servers:
  - url: https://sandbox.zsmart.com
    description: Sandbox environment for testing and development
  - url: https://api.zsmart.com
    description: Production environment for live transactions

components:
  schemas:
    ErrorCodes:
      type: object
      properties:
        DBEP0000:
          type: string
          description: Success - Indicates the operation was successful.
        DBEP0003:
          type: string
          description: Subscriber not found - The specified subscriber could not be found in the system.
        DBEP0031:
          type: string
          description: Account not found - The specified account could not be found.
        DBEP0069:
          type: string
          description: Invalid channelCode - The channel code provided is invalid.
        DBEP0205:
          type: string
          description: Subscriber status is not eligible - The subscriber is not eligible for this action.
        DBEP0351:
          type: string
          description: Invalid payment method - The provided payment method is invalid.
        DBEP0444:
          type: string
          description: The number is not prepaid - The number provided is not a prepaid account.
        DBEP0259:
          type: string
          description: Prepaid account not allowed to make payment - The prepaid account is restricted from making payments.
        DBEP0312:
          type: string
          description: msisdn and accountNumber cannot be null - Both msisdn and accountNumber cannot be empty simultaneously.
        DBEP0443:
          type: string
          description: Payment limit exceeded - The total payment amount exceeds the allowed limit for the current bill cycle or day.
        DBEP0518:
          type: string
          description: Channel status must be Active - The channel status must be active to perform this operation.
        DBEP0645:
          type: string
          description: eLoad account must be Active - The eLoad account status must be active.
        DBEP0646:
          type: string
          description: Staff not bound to eLoad account - The staff is not linked to an active eLoad account.
        DBEP0647:
          type: string
          description: Staff status must be Active - The staff member's status must be active to proceed.
        DBEP0638:
          type: string
          description: Incorrect password - The provided password is incorrect.
        DBEP0651:
          type: string
          description: MSISDN is not USSD-enabled - The MSISDN is not enabled for USSD transactions.
        DBEP0652:
          type: string
          description: Incorrect PIN - The provided PIN is incorrect.
        DBEP0648:
          type: string
          description: Transaction amount limit exceeded - The requested transaction amount exceeds the allowed limit.
        DBEP0006:
          type: string
          description: Insufficient credit balance - The account does not have enough credit to complete the transaction.
        DBEP0422:
          type: string
          description: Duplicate transaction - A duplicate transaction is not allowed.
        DBEP9999:
          type: string
          description: Other errors - A generic error for unforeseen issues.

paths: {}  # Paths to be defined as needed