User - Balance

Base URL: https://your-domain.com

Admin endpoints for managing subscriber and user balances. All endpoints require admin/staff authentication.

---

Get Subscriber Balance

Retrieve the current balance for a subscriber.

Property	Value
Endpoint	Get Subscriber Balance
Method	GET
URL	/api/v1/balance/subscriber/{id}
Authentication	Bearer Token

Request Headers:

Header	Value	Required
Accept	application/json	Yes
Authorization	Bearer your-auth-token	Yes

Path Parameters:

Parameter	Type	Required	Description
id	integer	Yes	Subscriber ID

Query Parameters:

Parameter	Type	Required	Description
isp_id	integer	Yes	ISP ID
branch_id	integer	Yes	Branch ID
user_id	integer	Yes	User ID

Success Response (200 OK):

{
    "success": true,
    "data": {
        "subscriber_id": 1,
        "subscriber_name": "John Doe",
        "balance": 1500.00,
        "last_transaction": "2024-01-15 10:30:00"
    }
}

Error Response (404 Not Found):

{
    "success": false,
    "message": "Subscriber not found"
}

---

Get User Balance

Retrieve the current balance for a user (reseller/staff).

Property	Value
Endpoint	Get User Balance
Method	GET
URL	/api/v1/balance/user/{id}
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
id	integer	Yes	User ID

Success Response (200 OK):

{
    "success": true,
    "data": {
        "user_id": 2,
        "user_name": "Reseller One",
        "balance": 5000.00,
        "last_transaction": "2024-01-15 10:30:00"
    }
}

---

Add Subscriber Balance

Add balance to a subscriber's account.

Property	Value
Endpoint	Add Subscriber Balance
Method	POST
URL	/api/v1/balance/subscriber/add
Authentication	Bearer Token

Request Headers:

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer your-auth-token	Yes

Request Body:

{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "subscriber_id": 1,
    "amount": 500
}

Parameter	Type	Required	Description
isp_id	integer	Yes	ISP ID
branch_id	integer	Yes	Branch ID
user_id	integer	Yes	Admin user ID
subscriber_id	integer	Yes	Subscriber ID
amount	decimal	Yes	Amount to add

Success Response (200 OK):

{
    "success": true,
    "message": "Balance added successfully",
    "data": {
        "new_balance": 2000.00,
        "transaction_id": 456
    }
}

Error Response (422 Validation Error):

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "amount": ["The amount must be greater than 0."]
    }
}

---

Get Subscriber Ledger

Retrieve balance transaction history for a subscriber.

Property	Value
Endpoint	Get Subscriber Ledger
Method	GET
URL	/api/v1/balance/subscriber/{id}/ledger
Authentication	Bearer Token

Path Parameters:

Parameter	Type	Required	Description
id	integer	Yes	Subscriber ID

Success Response (200 OK):

{
    "success": true,
    "data": [
        {
            "id": 1,
            "type": "credit",
            "amount": 500,
            "balance_after": 1500,
            "description": "Balance top-up",
            "created_at": "2024-01-15 10:30:00"
        }
    ]
}