AUD Payout

Get Payout List

Retrieve a list of payout transactions made within a specified time frame. This endpoint allows you to track payouts over a given period, with paging options for large datasets. You can query up to a 1-year period. If additional support for a longer time range is required, please contact our support team.

The query parameters from_date and to_date specify the time range, and page allows for pagination of results, with 20 records per page.

GET

payouts

Get Payout List

curl --request GET \
  --url https://api.cleverhub.co/api/v1/payouts/

import requests

url = "https://api.cleverhub.co/api/v1/payouts/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.cleverhub.co/api/v1/payouts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v1/payouts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cleverhub.co/api/v1/payouts/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/payouts/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/payouts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "from_date": "2022-01-01T00:00:00",
  "to_date": "2022-12-31T23:59:59",
  "page": 1,
  "size": 20,
  "next_page": 2,
  "total_page": 5,
  "total_count": 100,
  "records": [
    {
      "id": 12345,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "description": "Payout for invoice #12345",
      "payid": "sample@payid.com",
      "total_amount": "1000.00",
      "total_refund": "100.00",
      "total_failed_transactions": "2",
      "scheduled_at": "2024-12-31T23:59:59Z",
      "status": "processing",
      "export_url": "https://example.com/download/payout_attachment",
      "payout_notification": {
        "endpoint_url": "https://merchant.com/payout_callback",
        "authorization_header": "Bearer your_token"
      },
      "error_code": "HC_PAYOUT1",
      "error_message": "Insufficient funds to payout. Please top up balance in the dashboard.",
      "is_retry": false,
      "external_id": "custom-payout-id-6789",
      "payout_transactions": [
        {
          "id": 123,
          "balance_id": "550e8400-e29b-41d4-a716-446655441111",
          "payee": "John Doe",
          "payid": "payee@payid.com",
          "payid_type": "EMAIL",
          "bsb": "123456",
          "account_number": "987654321",
          "amount": "500.00",
          "status": "settled",
          "error_message": "Payment failed due to insufficient funds.",
          "created_at": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

Query Parameters

from_date

string<date-time>

required

Start date for querying payout requests. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.

to_date

string<date-time>

required

End date for querying payout requests. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.

page

integer

required

Page number to query. Each page contains up to 20 records. Use this parameter to navigate through multiple pages of results.

Response

Successful response with a list of payout transactions.

from_date

string<date-time>

The start date of the queried payout transactions, as specified in the request.

Example:

"2022-01-01T00:00:00"

to_date

string<date-time>

The end date of the queried payout transactions, as specified in the request.

Example:

"2022-12-31T23:59:59"

page

integer

The current page number of the returned results.

Example:

1

size

integer

The number of records per page. Default is 20.

Example:

20

next_page

integer

The page number for the next set of results, if available.

Example:

2

total_page

integer

The total number of pages available based on the query parameters.

Example:

5

total_count

integer

The total number of payout transactions available within the specified date range.

Example:

100

records

object[]

List of payout transactions.

Show child attributes

Create a Payout

Create Payout Batch via File

Get Payout List

curl --request GET \
  --url https://api.cleverhub.co/api/v1/payouts/

import requests

url = "https://api.cleverhub.co/api/v1/payouts/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.cleverhub.co/api/v1/payouts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v1/payouts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cleverhub.co/api/v1/payouts/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cleverhub.co/api/v1/payouts/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cleverhub.co/api/v1/payouts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "from_date": "2022-01-01T00:00:00",
  "to_date": "2022-12-31T23:59:59",
  "page": 1,
  "size": 20,
  "next_page": 2,
  "total_page": 5,
  "total_count": 100,
  "records": [
    {
      "id": 12345,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "description": "Payout for invoice #12345",
      "payid": "sample@payid.com",
      "total_amount": "1000.00",
      "total_refund": "100.00",
      "total_failed_transactions": "2",
      "scheduled_at": "2024-12-31T23:59:59Z",
      "status": "processing",
      "export_url": "https://example.com/download/payout_attachment",
      "payout_notification": {
        "endpoint_url": "https://merchant.com/payout_callback",
        "authorization_header": "Bearer your_token"
      },
      "error_code": "HC_PAYOUT1",
      "error_message": "Insufficient funds to payout. Please top up balance in the dashboard.",
      "is_retry": false,
      "external_id": "custom-payout-id-6789",
      "payout_transactions": [
        {
          "id": 123,
          "balance_id": "550e8400-e29b-41d4-a716-446655441111",
          "payee": "John Doe",
          "payid": "payee@payid.com",
          "payid_type": "EMAIL",
          "bsb": "123456",
          "account_number": "987654321",
          "amount": "500.00",
          "status": "settled",
          "error_message": "Payment failed due to insufficient funds.",
          "created_at": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Get Payout List

Query Parameters

Response