Balance - os-salahuddin/php8-cluster GitHub Wiki

User Balance

Get User Balance

This API provides User Balance information associated with a account

URL

[GET] http://127.0.0.1:8282/api/v1/private/user/balances

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "balances": [
            {
                "is_active": 1,
                "account_no": "PAA001649",
                "currency": "BDT",
                "balance": "৳138,603.14"
            }
        ]
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g. 200) Yes
messages Array Result messages Yes
data.balances Array List of user balances Yes
data.balances[].is_active Int Indicates if the balance is active (1 = active, 0 = inactive) Yes
data.balances[].account_no String Account number associated with the balance Yes
data.balances[].currency String Currency type (e.g., BDT) Yes
data.balances[].balance String Account balance with currency symbol Yes