Hello Clever Developer Docs

GET

payouts

detail

Get Payout Details

curl --request GET \
  --url https://api.cleverhub.co/api/v2/payouts/detail \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/payouts/detail"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/payouts/detail', 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/v2/payouts/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$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/v2/payouts/detail"

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

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

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

{
  "uuid": "OHXTEF9M",
  "currency": "AUD",
  "payout_method_name": "au_bank_aud",
  "description": "Payout payment 2023",
  "total_amount": "1000",
  "status": "created",
  "scheduled_at": null,
  "payout_transactions": [
    {
      "uuid": "GPZUNCM5",
      "balance_id": null,
      "payee": "Clever Hello",
      "email": "test@example.com",
      "amount": "100",
      "payout_method_params": {
        "bsb": "572505",
        "account_number": "76273288",
        "purpose_code": "other",
        "phone": "+61928312999"
      },
      "status": "created",
      "error_message": null,
      "reference": null,
      "external_id": null,
      "created_at": "2025-03-07T06:47:27.069+0000",
      "metadata": {
        "custom_note": "Priority payee"
      }
    }
  ],
  "external_id": "123",
  "error_code": "HC_PAYOUT1",
  "error_message": "",
  "webhook_notification": {
    "endpoint_url": "https://yourserver.co/notifications",
    "authorization_header": "****"
  }
}

Authorizations

app-id

string

header

required

A unique identifier assigned to each application.

secret-key

string

header

required

A secure token associated with the app-id.

Query Parameters

uuid

string

required

Hello Clever payout payment UUID (global-level ID of the payout request).

child_uuid

string

UUID of an individual payout transaction inside payout_transactions[]. If both uuid and child_uuid are provided, the system will prioritize uuid (parent-level UUID).

Response

uuid

string

Unique id in system.

Example:

"OHXTEF9M"

currency

string

Currency payout

Example:

"PHP"

payout_method_name

string

Example:

"ph_ewallet_gcash_php"

description

string

Description of payout payment.

Required string length: 1 - 90

Example:

"Payout payment 2023"

total_amount

string

Total amount of list payout transactions

Example:

"1000"

status

enum<string>

Status of payout payment

Available options:

created,

processing,

scheduled,

completed,

expired

Example:

"completed"

webhook_notification

object

Merchant Callback Details

Show child attributes

scheduled_at

string<YYYY-MM-DDTHH:mm:ss>

Payout transaction to payee in this time. This datetime would be in UTC timezone.

Example:

"2023-04-01T00:00:00.000+0000"

payout_transactions

object[]

Show child attributes

error_code

string

Error code for the batch. We have 2 error codes HC_PAYOUT1 (Insufficient funds to payout. Please topup balance in dashboard) and HC_PAYOUT2 (Insufficient Balance. Hello Clever will charge your PayTo agreement to pay out).

Example:

"HC_PAYOUT1"

error_message

string

A description corresponds to the value of the statusCode field.

Example:

"Insufficient available funds. Top up your balance."

external_id

string

Custom ID

Example:

"123"

Get Payout Details

curl --request GET \
  --url https://api.cleverhub.co/api/v2/payouts/detail \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://api.cleverhub.co/api/v2/payouts/detail"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'app-id': '<api-key>', 'secret-key': '<api-key>'}};

fetch('https://api.cleverhub.co/api/v2/payouts/detail', 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/v2/payouts/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$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/v2/payouts/detail"

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

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

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

{
  "uuid": "OHXTEF9M",
  "currency": "AUD",
  "payout_method_name": "au_bank_aud",
  "description": "Payout payment 2023",
  "total_amount": "1000",
  "status": "created",
  "scheduled_at": null,
  "payout_transactions": [
    {
      "uuid": "GPZUNCM5",
      "balance_id": null,
      "payee": "Clever Hello",
      "email": "test@example.com",
      "amount": "100",
      "payout_method_params": {
        "bsb": "572505",
        "account_number": "76273288",
        "purpose_code": "other",
        "phone": "+61928312999"
      },
      "status": "created",
      "error_message": null,
      "reference": null,
      "external_id": null,
      "created_at": "2025-03-07T06:47:27.069+0000",
      "metadata": {
        "custom_note": "Priority payee"
      }
    }
  ],
  "external_id": "123",
  "error_code": "HC_PAYOUT1",
  "error_message": "",
  "webhook_notification": {
    "endpoint_url": "https://yourserver.co/notifications",
    "authorization_header": "****"
  }
}

Basics

Payment APIs

Card API

Cashback API

Reporting API

Get Payout Details

Authorizations

Query Parameters

Response