API reference

The MyGigsters Payments API is a REST API. It accepts and returns JSON, and uses standard HTTP status codes.

Base URLs

Environment	Base URL
Demo (QA)	`https://qa-payments.mygigsters.com.au/api/v1`
Production	`https://prod-payments.mygigsters.com.au/api/v1`

The examples and the interactive playground in this reference use the demo environment. See Environments.

Authentication

Send your API key pair with HTTP Basic authentication, and include the version header on every request.

curl https://qa-payments.mygigsters.com.au/api/v1/customer/{customer_id} \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2"

const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/customer/{customer_id}", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "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/customer/{customer_id}",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "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/customer/{customer_id}")
request = Net::HTTP::Get.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
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/customer/{customer_id}");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "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;
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/customer/{customer_id}"))
            .header("Authorization", "Basic " + credentials)
            .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/customer/{customer_id}", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("YOUR_UUID", "YOUR_SECRET")
	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/customer/{customer_id}");
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());

Partner endpoints use a Bearer token instead. Get one from Authenticate partner. See Authentication for details.

Conventions

Versioning: send X-API-Version: 1.2. See API versioning.
Field names: version 1.2 uses snake_case for request and response fields.
Idempotency: send an idempotency-Key header on POST and PUT requests. See Idempotency.
Errors: every error returns the same JSON format. See Errors and conventions.

Overview

Partner account

Partner webhooks

Customers

Cards

Payment intents

Payments

Wallet

Workers

Payouts

Invoices

Credit notes

Subscriptions

Document verification

Base URLs

Authentication

Conventions

Resources

Customers

Cards

Payment intents

Payments

Wallet

Workers

Payouts

Invoices

Credit notes

Subscriptions

Document verification

Partner account

​Base URLs

​Authentication

​Conventions

​Resources

Customers

Cards

Payment intents

Payments

Wallet

Workers

Payouts

Invoices

Credit notes

Subscriptions

Document verification

Partner account

Base URLs

Authentication

Conventions

Resources