Get Payout Requests in a Period of Time

GET 
https://api.cleverhub.co/api/v2/payouts/all

You can easily query payout payments in a period of time. Currently we support up to 1 year period. Should you need more, please contact us directly.

Request

Query Parameters

from_date stringrequired
Start date to queries payment requests from, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
to_date stringrequired
End date to queries payment requests, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
page stringrequired

Page number to query. Currently we support 20 records per page

Responses

200

OK

application/json

Schema

Schema

from_datestringrequired
Example: 2022-01-01T00:00:00.000+0000
to_datestringrequired
Example: 2022-12-01T00:00:00.000+0000
pageintegerrequired
Example: 1
sizeintegerrequired
Example: 10
next_pageintegerrequired
Example: 2
total_pageintegerrequired
Example: 1
total_countintegerrequired
Example: 10
records object[]required
Array [
uuidstringrequired
Example: OHXTEF9M
currencystringrequired
Currency payout
Example: PHP
payout_method_namestringrequired
Payout method
Example: ph_ewallet_gcash_php
descriptionstringrequired
Description of payout payment.
Possible values: non-empty and <= 90 characters
Example: Payout payment 2023
total_amountstringrequired
Total amount of list payout transactions
Example: 1000
statusstringrequired
Status of payout payment
Possible values: [created, processing, scheduled, completed, expired]
Example: completed
webhook_notification object
Merchant Callback Details
endpoint_urlurl (endpoint_url)required
An internet accessible url which Hello Clever will invoke when the status of the transaction has changed. The call will be done using the HTTP POST method. The endpoint exposed by the client must be TLS 1.2 and the server certificate must be issued by a well known commercial certificate authority and that self-signed or internally signed certs are not acceptable.
Example: https://example.org
authorization_header(authorization_header)required
The string which Hello Clever will put into the Authorization request header when calling the Callback url.
Example: SECRET
scheduled_atYYYY-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[]
Array [
uuidstringrequired
Example: OHXTEF9M
balance_idstringrequired
Balance transaction UUID
Example: 808C75EF-988143EB
payeestringrequired
Name of payee.
Example: John Scarlet
amountstringrequired
Amount to charge payment.
Example: 100.00
payout_method_paramsobjectrequired
Required parameters for payout method name
Example: {"account_number":123456789999,"account_name":"Luyx","bank_code":11111}
statusstringrequired
Status of payout transaction
Possible values: [created, processing, settled, failed]
Example: settled
error_messagestringrequired
Error message when payout transaction failed.
Example: PayID not found
created_atstringrequired
Timestamp when the payout transaction was created (UTC Time)
Example: 2022-01-01T00:00:00.000+0000
]
error_codestringrequired
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_messagestringrequired
A description corresponds to the value of the statusCode field.
Example: Insufficient available funds. Top up your balance.
external_idstringrequired
Custom ID
Example: 123
]

Example (auto)

{
  "from_date": "2022-01-01T00:00:00.000+0000",
  "to_date": "2022-12-01T00:00:00.000+0000",
  "page": 1,
  "size": 10,
  "next_page": 2,
  "total_page": 1,
  "total_count": 10,
  "records": [
    {
      "uuid": "OHXTEF9M",
      "currency": "PHP",
      "payout_method_name": "ph_ewallet_gcash_php",
      "description": "Payout payment 2023",
      "total_amount": "1000",
      "status": "completed",
      "webhook_notification": {
        "endpoint_url": "https://example.org",
        "authorization_header": "SECRET"
      },
      "scheduled_at": "2023-04-01T00:00:00.000+0000",
      "payout_transactions": [
        {
          "uuid": "OHXTEF9M",
          "balance_id": "808C75EF-988143EB",
          "payee": "John Scarlet",
          "amount": "100.00",
          "payout_method_params": {
            "account_number": 123456789999,
            "account_name": "Luyx",
            "bank_code": 11111
          },
          "status": "settled",
          "error_message": "PayID not found",
          "created_at": "2022-01-01T00:00:00.000+0000"
        }
      ],
      "error_code": "HC_PAYOUT1",
      "error_message": "Insufficient available funds. Top up your balance.",
      "external_id": "123"
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

404

Not Found

application/json

Schema

Schema

errors object
messagestring

Example (auto)

{
  "errors": {
    "message": "string"
  }
}

Example

{
  "errors": {
    "message": "Not found"
  }
}

422

Unporcessable Entity

application/json

Schema

Schema

errors object
messagestring

Example (auto)

{
  "errors": {
    "message": "string"
  }
}

Example

{
  "errors": {
    "message": "Invalid date"
  }
}

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• 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/v2/payouts/all");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

from_date — queryrequired

to_date — queryrequired

page — queryrequired

ResponseClear

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