Get Payout List

GET 
https://api.cleverhub.co/api/v1/payouts/

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.

Request

Query Parameters

from_date date-timerequired
Start date for querying payout requests. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.
Example: 2022-01-01T00:00:00
to_date date-timerequired
End date for querying payout requests. Accepted formats are 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This date-time is in UTC.
Example: 2022-12-31T23:59:59
page integerrequired
Page number to query. Each page contains up to 20 records. Use this parameter to navigate through multiple pages of results.
Example: 1

Responses

200

Successful response with a list of payout transactions.

application/json

Schema

Schema

from_datedate-time
The start date of the queried payout transactions, as specified in the request.
Example: 2022-01-01T00:00:00
to_datedate-time
The end date of the queried payout transactions, as specified in the request.
Example: 2022-12-31T23:59:59
pageinteger
The current page number of the returned results.
Example: 1
sizeinteger
The number of records per page. Default is 20.
Example: 20
next_pageinteger
The page number for the next set of results, if available.
Example: 2
total_pageinteger
The total number of pages available based on the query parameters.
Example: 5
total_countinteger
The total number of payout transactions available within the specified date range.
Example: 100
records object[]
List of payout transactions.
Array [
idinteger
A unique identifier assigned to the payout payment, used for tracking and referencing purposes within the system.
Example: 12345
uuidstring
A unique UUID assigned to the payout payment, providing a globally unique reference for the transaction.
Example: 550e8400-e29b-41d4-a716-446655440000
descriptionstring
A description of the payout payment, providing context or additional information such as the purpose of the payout.
Example: Payout for invoice #12345
payidstring
The PayID used for topping up the payout payment, allowing for easy routing of funds to the correct recipient.
Example: sample@payid.com
total_amountstring
The total amount of all transactions included in the payout, providing the complete value being paid out.
Example: 1000.00
total_refundstring
The total amount that has been refunded to the payee, if applicable.
Example: 100.00
total_failed_transactionsstring
The total number of transactions within the payout that failed to complete successfully.
Example: 2
scheduled_atdate-time
The date and time when the payout transaction is scheduled to occur, expressed in UTC.
Example: 2024-12-31T23:59:59Z
statusstring
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.
Possible values: [created, processing, scheduled, completed, expired]
Example: processing
export_urluri
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.
endpoint_urluri
An internet-accessible URL that will be invoked when the status of the payout changes, allowing the merchant to receive real-time updates.
Example: https://merchant.com/payout_callback
authorization_headerstring
The authorization header value to be used in the callback request, helping ensure the request is authenticated.
Example: Bearer your_token
error_codestring
An error code associated with the payout, indicating any issues that occurred during processing.
Example: HC_PAYOUT1
error_messagestring
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_retryboolean
Indicates whether the payout is being retried after a previous failure.
Example: false
external_idstring
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.
Array [
idinteger
A unique identifier assigned to the payout transaction, used for tracking and referencing purposes.
Example: 123
balance_idstring
The UUID of the balance transaction associated with the payout, providing a reference to the specific balance movement.
Example: 550e8400-e29b-41d4-a716-446655441111
payeestring
The name of the payee receiving the payout, used to identify the recipient of the funds.
Example: John Doe
payidstring
The PayID of the payee, used to route the payout to the correct recipient.
Example: payee@payid.com
payid_typestring
The type of PayID being used by the payee. Valid values include:
• EMAIL: An email address.
• PHONE: A phone number.
• ABN: An Australian Business Number.
Possible values: [EMAIL, PHONE, ABN]
Example: EMAIL
bsbstring
The Bank-State-Branch (BSB) number of the payee's account, used to identify the bank and branch for the transaction.
Example: 123456
account_numberstring
The account number of the payee, used to route the payout to the correct bank account.
Example: 987654321
amountstring
The amount being paid to the payee as part of the payout transaction.
Example: 500.00
statusstring
The current status of the payout transaction. Possible values include:
• created: The transaction has been created but not yet processed.
• processing: The transaction is currently being processed.
• settled: The transaction has been completed successfully.
• failed: The transaction failed to complete successfully.
Possible values: [created, processing, settled, failed]
Example: settled
error_messagestring
An error message providing details about why the payout transaction failed, if applicable.
Example: Payment failed due to insufficient funds.
created_atdate-time
The date and time when the payout transaction was created, expressed in UTC.
Example: 2024-01-01T00:00:00Z
]
]

Example (auto)

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

400

Bad Request

401

Unauthorized

404

Not Found

422

Unprocessable Entity

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v1/payouts/");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Parameters

from_date — queryrequired

to_date — queryrequired

page — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!