> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.littglobal.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.littglobal.com/_mcp/server.

# Get Wallet Balance

POST TBD/api/v2/users/balance

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.

Reference: https://docs.littglobal.com/litt-white-label/api-reference/digital-wallet/get-wallet-balance

## Request

### Query parameters

- `api_token` (string, optional)

## Response

### 200

Get Wallet Balance

- `message` (string, optional)
- `api` (string, optional)
- `status` (string, optional)
- `data` (ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaData, optional)

## Types

### ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaData

- `wallet_balance` (string, optional)
- `currecy_symbol` (string, optional)
- `reward_point_balance` (integer, optional)
- `gold_coin_balance` (integer, optional)
- `currency` (ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaDataCurrency, optional)
- `litt_card_application_fee` (integer, optional)
- `reward_point_conversion_rate` (double, optional)
- `reward_point_conversion_options` (list of ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaDataRewardPointConversionOptionsItems, optional)

### ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaDataCurrency

- `id` (integer, optional)
- `name` (string, optional)
- `code` (string, optional)
- `code_symbol` (string, optional)
- `exchange_rate` (double, optional)
- `decimal_digits` (integer, optional)
- `rounding` (integer, optional)
- `status` (integer, optional)
- `is_base_currency` (boolean, optional)

### ApiV2UsersBalancePostResponsesContentApplicationJsonSchemaDataRewardPointConversionOptionsItems

- `points` (integer, optional)
- `amount` (integer, optional)

## Examples

**Response**

```json
{
  "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
      }
    ]
  }
}
```

**SDK Code**

```python Digital Wallet_getWalletBalance_example
import requests

url = "https://tbd/api/v2/users/balance"

querystring = {"api_token":"{{token}}"}

response = requests.post(url, params=querystring)

print(response.json())
```

```javascript Digital Wallet_getWalletBalance_example
const url = 'https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Digital Wallet_getWalletBalance_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Digital Wallet_getWalletBalance_example
require 'uri'
require 'net/http'

url = URI("https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
```

```java Digital Wallet_getWalletBalance_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D")
  .asString();
```

```php Digital Wallet_getWalletBalance_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D');

echo $response->getBody();
```

```csharp Digital Wallet_getWalletBalance_example
using RestSharp;

var client = new RestClient("https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift Digital Wallet_getWalletBalance_example
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://tbd/api/v2/users/balance?api_token=%7B%7Btoken%7D%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```