Quickstart

This walkthrough takes you through a complete super integration in the demo environment, from creating an API key to tracking a contribution.

Don’t want to build onboarding screens? Steps 3 and 4 can be done with embedded components instead.

Create an API key

Make your first request

Check your credentials by listing your employees.

curl 'https://qa-super.mygigsters.com.au/v1/employees' \
  -u 'apiUsername:apiPassword'

const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
  },
});

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

import requests

response = requests.get(
    "https://qa-super.mygigsters.com.au/v1/employees",
    auth=("apiUsername", "apiPassword"),
)

print(response.json())

require "net/http"
require "json"
require "uri"

uri = URI("https://qa-super.mygigsters.com.au/v1/employees")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")

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-super.mygigsters.com.au/v1/employees");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "apiUsername:apiPassword",
]);

$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;
import java.util.Base64;

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

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees"))
            .header("Authorization", "Basic " + credentials)
            .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-super.mygigsters.com.au/v1/employees", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("apiUsername", "apiPassword")

	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-super.mygigsters.com.au/v1/employees");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));

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

Onboard an employer

Create the employer of record with Onboard employer. This sets up the company details, the contact, and the bank account contributions are debited from. The direct debit agreement must be accepted to complete onboarding. See Onboard an employer.

Add each freelancer with Create employee. To pre-fill their fund details, search with SuperSelector, or let them pick from active funds. See Add employees.

Validate before you pay

Check each fund’s USI with Validate superannuation fund. To confirm the fund will accept contributions for that member, use member verification.

Submit a contribution

Send the contribution with Submit contribution. For large pay runs, use async submissions.

Track it to the fund

Follow the contribution with Get contribution history and Get payment status, or register a webhook to be notified.

Handle errors

Check the status code on every response.
Fix and resend 4xx errors. The response body says which field was wrong.
Retry 5xx errors with exponential backoff.

Last modified on November 11, 2026

Get started

Guides

Handle errors

​Handle errors

Handle errors