curl -X GET https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"X-API-Version": "1.2",
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance",
headers={
"Authorization": "Bearer <accessToken>",
"X-API-Version": "1.2",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["X-API-Version"] = "1.2"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"X-API-Version: 1.2",
],
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance"))
.header("Authorization", "Bearer <accessToken>")
.header("X-API-Version", "1.2")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("X-API-Version", "1.2")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
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/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<accessToken>");
request.Headers.Add("X-API-Version", "1.2");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"success": true,
"balances": [
{
"available_amount": 15420.50,
"currency": "AUD",
"pending_amount": 1200.00,
"reserved_amount": 0,
"total_amount": 16620.50,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 8350.00,
"currency": "USD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 8350.00,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 4200.75,
"currency": "SGD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 4200.75,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 3100.20,
"currency": "GBP",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 3100.20,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 25000.00,
"currency": "HKD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 25000.00,
"prepayment_amount": 0,
"account_type": "cash"
}
]
}
Partner account
Get connected account balances
Returns the real-time multi-currency wallet balances (including available, pending, and reserved funds) for the specified connected account across supported currencies such as AUD, USD, SGD, GBP, and HKD.
GET
/
connected-account
/
{account_id}
/
balance
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"X-API-Version": "1.2",
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance",
headers={
"Authorization": "Bearer <accessToken>",
"X-API-Version": "1.2",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["X-API-Version"] = "1.2"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"X-API-Version: 1.2",
],
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance"))
.header("Authorization", "Bearer <accessToken>")
.header("X-API-Version", "1.2")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("X-API-Version", "1.2")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
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/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<accessToken>");
request.Headers.Add("X-API-Version", "1.2");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"success": true,
"balances": [
{
"available_amount": 15420.50,
"currency": "AUD",
"pending_amount": 1200.00,
"reserved_amount": 0,
"total_amount": 16620.50,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 8350.00,
"currency": "USD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 8350.00,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 4200.75,
"currency": "SGD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 4200.75,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 3100.20,
"currency": "GBP",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 3100.20,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 25000.00,
"currency": "HKD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 25000.00,
"prepayment_amount": 0,
"account_type": "cash"
}
]
}
Headers
string
required
Target API version (e.g.
1.2).Path Parameters
string
required
The unique MyGigsters client UUID of the connected account (e.g.
f57ddb6d-c55d-44a6-a98a-2dbef12278a0).Response Body
boolean
Indicates whether the balance query succeeded (
true).array of objects
List of multi-currency balance entries supported for the connected account.
string
Three-letter ISO currency code (e.g.
AUD, USD, SGD, GBP, HKD).number
Cleared funds available for immediate payout or transfer.
number
Incoming funds awaiting settlement.
number
Funds temporarily held for pending transactions or risk collateral.
number
Total aggregate account balance (available + pending + reserved).
string
Wallet classification type, usually
cash.Response Codes
| Code | Description |
|---|---|
| 200 | Multi-currency balances retrieved successfully. |
| 401 | Unauthorized. Missing, expired, or invalid partner Bearer token. |
| 404 | Not Found. Connected account not found. |
| 500 | Internal Server Error. |
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"X-API-Version": "1.2",
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance",
headers={
"Authorization": "Bearer <accessToken>",
"X-API-Version": "1.2",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["X-API-Version"] = "1.2"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"X-API-Version: 1.2",
],
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance"))
.header("Authorization", "Bearer <accessToken>")
.header("X-API-Version", "1.2")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("X-API-Version", "1.2")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
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/connected-account/f57ddb6d-c55d-44a6-a98a-2dbef12278a0/balance");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<accessToken>");
request.Headers.Add("X-API-Version", "1.2");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"success": true,
"balances": [
{
"available_amount": 15420.50,
"currency": "AUD",
"pending_amount": 1200.00,
"reserved_amount": 0,
"total_amount": 16620.50,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 8350.00,
"currency": "USD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 8350.00,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 4200.75,
"currency": "SGD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 4200.75,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 3100.20,
"currency": "GBP",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 3100.20,
"prepayment_amount": 0,
"account_type": "cash"
},
{
"available_amount": 25000.00,
"currency": "HKD",
"pending_amount": 0,
"reserved_amount": 0,
"total_amount": 25000.00,
"prepayment_amount": 0,
"account_type": "cash"
}
]
}
Last modified on November 10, 2026
Was this page helpful?