Get Wallet Balance

POST

https://tbd/api/v2/users/balance

POST

/api/v2/users/balance

curl -X POST "https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D"

200Digital Wallet_getWalletBalance_example

{
  "message": "Your wallet balance now",
  "api": "user-balance",
  "status": "success",
  "data": {
    "wallet_balance": "123.00",
    "currecy_symbol": "A$",
    "reward_point_balance": 156,
    "gold_coin_balance": 0,
    "currency": {
      "id": 1,
      "name": "Australian Dollar",
      "code": "AUD",
      "code_symbol": "A$",
      "exchange_rate": 1.000001,
      "decimal_digits": 2,
      "rounding": 0,
      "status": 1,
      "is_base_currency": true
    },
    "litt_card_application_fee": 0,
    "reward_point_conversion_rate": 0.001000001,
    "reward_point_conversion_options": [
      {
        "points": 1000,
        "amount": 1
      },
      {
        "points": 2000,
        "amount": 2
      },
      {
        "points": 5000,
        "amount": 5
      },
      {
        "points": 10000,
        "amount": 10
      }
    ]
  }
}

The API endpoint is useful for accessing a user’s wallet balance, reward points, gold coin balance, and associated currency details. There is an additional feature to display the application fee for the Litt card and the conversion rate for reward points.

Request Body

No fields are required for the request.

Response

wallet_balance (string): The user’s current wallet balance.
currency_symbol (string): Symbol representing the user’s currency.
reward_point_balance (integer): The balance of the user’s reward points.
gold_coin_balance (integer): The balance of the user’s gold coins.
currency (object): Comprehensive details regarding the currency type which include id, name, code, symbol, exchange rate, decimal digits, rounding, status, and a boolean indicating if it is a base currency.
litt_card_application_fee (float): The application fee for the Litt card.
reward_point_conversion_rate (float): The conversion rate for the reward points.
reward_point_conversion_options (array): An array displaying different reward point conversion possibilities. Each object contains the amount in points and their equivalent monetary value.

Query parameters

api_tokenstringOptional

Response

Get Wallet Balance

messagestringOptional

apistringOptional

statusstringOptional

dataobjectOptional