curl -X GET https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661 \
-H "Content-Type: application/json" \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661",
headers={
"Authorization": "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["Content-Type"] = "application/json"
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"Content-Type: application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661"))
.header("Authorization", "Bearer <accessToken>")
.header("Content-Type", "application/json")
.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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("Content-Type", "application/json")
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
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());
{
"status": 200,
"message": "Batch payout status fetched successfully",
"batch_id": "bat_1d9248bb02add09754f4b9d527c88661",
"batch": [
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "NPP",
"currency": "AUD",
"amount": "250.50",
"remarks": "October payment",
"reference": "PAY-001",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
},
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "BANK_TRANSFER",
"currency": "AUD",
"amount": "10.00",
"remarks": "October payment",
"reference": "PAY-002",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
}
]
}
Partner account
Batch status
Retrieves the real-time processing and approval status for all individual payment line items in a previously submitted payout batch.
GET
/
payouts
/
batch
/
{batchId}
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661 \
-H "Content-Type: application/json" \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661",
headers={
"Authorization": "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["Content-Type"] = "application/json"
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"Content-Type: application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661"))
.header("Authorization", "Bearer <accessToken>")
.header("Content-Type", "application/json")
.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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("Content-Type", "application/json")
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
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());
{
"status": 200,
"message": "Batch payout status fetched successfully",
"batch_id": "bat_1d9248bb02add09754f4b9d527c88661",
"batch": [
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "NPP",
"currency": "AUD",
"amount": "250.50",
"remarks": "October payment",
"reference": "PAY-001",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
},
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "BANK_TRANSFER",
"currency": "AUD",
"amount": "10.00",
"remarks": "October payment",
"reference": "PAY-002",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
}
]
}
Headers
string
required
Target API version (e.g.
1.2).Path Parameters
string
required
The batch ID returned from the batch creation request (e.g.
bat_1d9248bb02add09754f4b9d527c88661).Response Body
number
HTTP status code (200).
string
Status confirmation:
Batch payout status fetched successfully.string
The unique identifier of the queried batch.
array of objects
List of individual payout line items and their respective execution statuses.
string
Current payment lifecycle state (e.g.
PENDING, COMPLETED, FAILED).string
Internal approval workflow state (e.g.
PENDING, APPROVED).string
Clearing system used (
NPP or BANK_TRANSFER).string
Payment line item amount.
string
ISO 8601 timestamp when this payout entry was registered.
Response Codes
| Code | Description |
|---|---|
| 200 | Batch payout status retrieved successfully. |
| 401 | Unauthorized. Missing, expired, or invalid partner Bearer token. |
| 404 | Not Found. Batch with the specified batchId does not exist. |
| 500 | Internal Server Error. |
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661 \
-H "Content-Type: application/json" \
-H "X-API-Version: 1.2" \
-H "Authorization: Bearer <accessToken>"
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", {
method: "GET",
headers: {
Authorization: "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661",
headers={
"Authorization": "Bearer <accessToken>",
"Content-Type": "application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <accessToken>"
request["Content-Type"] = "application/json"
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <accessToken>",
"Content-Type: application/json",
"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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661"))
.header("Authorization", "Bearer <accessToken>")
.header("Content-Type", "application/json")
.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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <accessToken>")
req.Header.Set("Content-Type", "application/json")
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/payouts/batch/bat_1d9248bb02add09754f4b9d527c88661");
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());
{
"status": 200,
"message": "Batch payout status fetched successfully",
"batch_id": "bat_1d9248bb02add09754f4b9d527c88661",
"batch": [
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "NPP",
"currency": "AUD",
"amount": "250.50",
"remarks": "October payment",
"reference": "PAY-001",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
},
{
"bsb_number": "065163",
"account_number": "12345678",
"account_name": "Jane",
"entity_type": "PERSONAL",
"clearing_system": "BANK_TRANSFER",
"currency": "AUD",
"amount": "10.00",
"remarks": "October payment",
"reference": "PAY-002",
"status": "PENDING",
"approvalstatus": "PENDING",
"airwallex_response": null,
"created_at": "2026-10-14T12:10:09.000Z"
}
]
}
Last modified on November 10, 2026
Was this page helpful?