> ## 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.

# Payout status

> This endpoint is used to retrieve the payout status of a worker.

### Headers

**X-API-Version** `string` *required* (default: 1.2)

The API version to use. Supported versions are `1.1` and `1.2`.

### Request Body Parameters

**transfer\_id** `string` *required*

The unique identifier for the transfer.

### Response Body

| Field | Type | Description |
| - | - | - |
| `status` | number | The HTTP status code of the response. |
| `message` | string | Provides information about the payout status retrieval result. |
| `data`object | object | Contains the detailed payout information. |
| ↳`amount` | number | The payout amount. |
| ↳`currency` | string | The currency of the payout. |
| ↳`beneficiary`object | object | Details about the payout beneficiary. |
| ↳`entity_type` | string | The entity type of beneficiary (e.g. "PERSONAL"). |
| ↳`bank_details`object | object | Beneficiary bank account details. |
| ↳`account_currency` | string | The account currency code (e.g. "AUD"). |
| ↳`account_name` | string | The name associated with the bank account. |
| ↳`account_number` | string | The bank account number. |
| ↳`account_routing_type1` | string | The routing type identifier (e.g. "bsb"). |
| ↳`account_routing_value1` | string | The routing value (e.g. BSB number). |
| ↳`bank_country_code` | string | The ISO country code of the bank (e.g. "AU"). |
| ↳`bank_name` | string | The name of the issuing bank. |
| ↳`local_clearing_system` | string | The clearing system (e.g. "BANK\_TRANSFER"). |
| ↳`entity_type` | string | The entity type (e.g. "INDIVIDUAL" or "COMPANY"). |
| ↳`status` | string | The current status of the payout (e.g., "PENDING", "PROCESSING", "PAID", "FAILED", "CANCELLED"). |

### Response Codes

| Code | Description |
| - | - |
| 200 | If the request is successful, the payout status is retrieved and the response includes detailed information about the transfer. |
| 400 | Bad Request. Invalid or missing parameters. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 404 | Not Found. The specified transferId was not found. |
| 500 | Internal Server Error. |

```bash cURL theme={null}
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json" \
  -d '{
  "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c"
}'
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status", {
  method: "POST",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "X-API-Version": "1.2",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c"
  }),
});

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

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

response = requests.post(
    "https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "X-API-Version": "1.2",
    },
    json={
        "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c",
    },
)

print(response.json())
```

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

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status")
request = Net::HTTP::Post.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
request["X-API-Version"] = "1.2"
request["Content-Type"] = "application/json"
request.body = <<~JSON
  {
    "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c"
  }
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/worker-payout-status");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "X-API-Version: 1.2",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c"
}
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());

        String body = String.join("\n",
            "{",
            "  \"transfer_id\": \"d34bdd01-5bad-4a74-9511-0d58a11ca26c\"",
            "}"
        );

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status"))
            .header("Authorization", "Basic " + credentials)
            .header("X-API-Version", "1.2")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .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"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "transfer_id": "d34bdd01-5bad-4a74-9511-0d58a11ca26c"
}`)

	req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status", body)
	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.Post, "https://qa-payments.mygigsters.com.au/api/v1/worker-payout-status");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("YOUR_UUID:YOUR_SECRET")));
request.Headers.Add("X-API-Version", "1.2");
request.Content = new StringContent(@"{
  ""transfer_id"": ""d34bdd01-5bad-4a74-9511-0d58a11ca26c""
}", Encoding.UTF8, "application/json");

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

```json 200 theme={null}
{
  "status": 200,
  "message": "Payout status fetched successfully",
  "data": {
    "amount": 550,
    "currency": "AUD",
    "beneficiary": {
      "bank_details": {
        "account_currency": "AUD",
        "account_name": "Jane Smith",
        "account_number": "716978952",
        "account_routing_type1": "bsb",
        "account_routing_value1": "083064",
        "bank_country_code": "AU",
        "bank_name": "National Australia Bank Limited",
        "local_clearing_system": "BANK_TRANSFER"
      },
      "entity_type": "PERSONAL"
    },
    "status": "CANCELLED"
  }
}
```


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