AUD Payout

Get Payout Detail

Retrieve detailed information about a specific payout payment, including its status, total amount, failed transactions, and other relevant details. This endpoint allows you to check the payout payment’s current status and access additional information such as notification details and associated transactions.

Payout payment statuses:

created: The payout payment has been created.
processing: The payout is currently in progress and funds are being topped up to the PayID.
scheduled: The payout is scheduled and awaiting transfer to the payee.
completed: The payout payment has been successfully completed.
expired: The payout payment has expired.

GET

payouts

detail

Get Payout Detail

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v1/payouts/detail",
  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/detail"

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

	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/v1/payouts/detail")

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

{
  "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

integer

required

Unique identifier (ID) for the payout payment within Hello Clever.

uuid

string

Unique UUID for the payout payment, used to identify the transaction uniquely.

Response

Successfully retrieved payout payment details.

integer

A unique identifier assigned to the payout payment, used for tracking and referencing purposes within the system.

Example:

12345

uuid

string

A unique UUID assigned to the payout payment, providing a globally unique reference for the transaction.

Example:

"550e8400-e29b-41d4-a716-446655440000"

description

string

A description of the payout payment, providing context or additional information such as the purpose of the payout.

Example:

"Payout for invoice #12345"

payid

string

The PayID used for topping up the payout payment, allowing for easy routing of funds to the correct recipient.

Example:

"sample@payid.com"

total_amount

string

The total amount of all transactions included in the payout, providing the complete value being paid out.

Example:

"1000.00"

total_refund

string

The total amount that has been refunded to the payee, if applicable.

Example:

"100.00"

total_failed_transactions

string

The total number of transactions within the payout that failed to complete successfully.

Example:

"2"

scheduled_at

string<date-time>

The date and time when the payout transaction is scheduled to occur, expressed in UTC.

Example:

"2024-12-31T23:59:59Z"

status

enum<string>

The current status of the payout payment. Possible values include:

created: The payout has been created but not yet processed.
processing: The payout is currently being processed.
scheduled: The payout is scheduled for a future date.
completed: The payout has been completed successfully.
expired: The payout has expired.

Available options:

created,

processing,

scheduled,

completed,

expired

Example:

"processing"

export_url

string<uri>

A URL for downloading an attachment related to the payout payment, such as a receipt or transaction details.

Example:

"https://example.com/download/payout_attachment"

payout_notification

object

Details regarding the merchant callback settings for payout status updates, including the endpoint URL and authorization header.

Show child attributes

error_code

string

An error code associated with the payout, indicating any issues that occurred during processing.

Example:

"HC_PAYOUT1"

error_message

string

A description of the error encountered during the payout process, providing context for troubleshooting.

Example:

"Insufficient funds to payout. Please top up balance in the dashboard."

is_retry

boolean

Indicates whether the payout is being retried after a previous failure.

Example:

false

external_id

string

A custom identifier for the payout, provided by the merchant for tracking and reference purposes.

Example:

"custom-payout-id-6789"

payout_transactions

object[]

A list of individual transactions that are part of the payout, including details such as payee information and transaction status.

Show child attributes

Get Payout Detail

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cleverhub.co/api/v1/payouts/detail",
  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/detail"

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

	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/v1/payouts/detail")

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

{
  "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"
    }
  ]
}

Basics

Payment APIs

Card API

Cashback API

Reporting API

Get Payout Detail

Query Parameters

Response