> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get wallet balances

> Returns the real-time multi-currency wallet balances (including available, pending, and reserved funds across AUD, SGD, USD, etc.) along with the associated settlement banking and clearing details.

### Headers

**x-api-version** `string` *required*

Target API version header (e.g. `1.2`).

### Response Body

The response for the Get Wallet Balances request is a JSON object with the following schema:

| Field | Type | Description |
| - | - | - |
| `success` | boolean | Indicates whether the request was successful (e.g. `true`). |
| `balances`array | array of objects | List of multi-currency wallet balance figures. |
| ↳`available_amount` | number | Cleared funds available for immediate payout or transfer. |
| ↳`currency` | string | Three-letter ISO currency code (e.g. `AUD`, `SGD`, `USD`). |
| ↳`pending_amount` | number | Incoming funds currently awaiting settlement. |
| ↳`reserved_amount` | number | Funds temporarily held or reserved for pending transactions / collateral. |
| ↳`total_amount` | number | Total aggregate account balance (`available_amount + pending_amount + reserved_amount`). |
| ↳`prepayment_amount` | number | Prepayment credit balance, if any. |
| ↳`account_type` | string | Wallet classification type (e.g. `cash`). |
| `account_object`object | object | Depository and settlement banking details associated with the primary account. |
| ↳`account_name` | string | Registered bank account holder name. |
| ↳`account_number` | string | Settlement bank account number. |
| ↳`account_type` | string | Bank account classification (e.g. `Checking`, `Current`, `Cash`). |
| ↳`account_provider` | string | Banking infrastructure provider (e.g. `AIRWALLEX`). |
| ↳`bank_name` | string | Name of the depository institution (e.g. `Australia and New Zealand Banking Group Limited`). |
| ↳`bank_address` | string | Depository institution physical branch address. |
| ↳`bank_code` | string | SWIFT/BIC or bank identifier code (e.g. `CMFGUS33`). |
| ↳`bsb` | string | Routing number or Australian BSB code (e.g. `013943`). |

### Response Codes

| Code | Description |
| - | - |
| 200 | Wallet balances and account details retrieved successfully. |
| 401 | Unauthorized. Missing or invalid API key credentials. |
| 500 | Internal Server Error. |

```bash cURL theme={null}
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/wallet \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json"
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/wallet", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "X-API-Version": "1.2",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.get(
    "https://qa-payments.mygigsters.com.au/api/v1/wallet",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "X-API-Version": "1.2",
        "Content-Type": "application/json",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/wallet")
request = Net::HTTP::Get.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
request["X-API-Version"] = "1.2"
request["Content-Type"] = "application/json"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/wallet");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "X-API-Version: 1.2",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("YOUR_UUID:YOUR_SECRET".getBytes());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/wallet"))
            .header("Authorization", "Basic " + credentials)
            .header("X-API-Version", "1.2")
            .header("Content-Type", "application/json")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/wallet", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("YOUR_UUID", "YOUR_SECRET")
	req.Header.Set("X-API-Version", "1.2")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-payments.mygigsters.com.au/api/v1/wallet");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("YOUR_UUID:YOUR_SECRET")));
request.Headers.Add("X-API-Version", "1.2");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "success": true,
  "balances": [
    {
      "available_amount": 1596750.06,
      "currency": "AUD",
      "pending_amount": 0,
      "reserved_amount": 33.35,
      "total_amount": 1596783.41,
      "prepayment_amount": 0,
      "account_type": "cash"
    },
    {
      "available_amount": 349394.08,
      "currency": "SGD",
      "pending_amount": 0,
      "reserved_amount": 0,
      "total_amount": 349394.08,
      "prepayment_amount": 0,
      "account_type": "cash"
    },
    {
      "available_amount": 566186.86,
      "currency": "USD",
      "pending_amount": 0,
      "reserved_amount": 0,
      "total_amount": 566186.86,
      "prepayment_amount": 0,
      "account_type": "cash"
    }
  ],
  "account_object": {
    "account_name": "MEGAMIND CREATIONS AUSTRALIA PTY LTD",
    "account_number": "613090253",
    "account_type": "Current",
    "account_provider": "AIRWALLEX",
    "bank_name": "Australia and New Zealand Banking Group Limited",
    "bank_address": "833 Collins Street, Melbourne, Victoria, 3000",
    "bank_code": "N.A.",
    "bsb": "013943"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.