Skip to main content

Get Payout Details

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

Check the status of a payout payment. There are 4 statuses:

  • created: Payout payment created.
  • processing: Payout has been topup to payID response.
  • scheduled: Waiting charge fund to payee.
  • completed: Payout payment completed.

Request​

Query Parameters

    uuid stringrequired

    Hello Clever payout payment UUID

Responses​

OK

Schema
    uuidstringrequired

    Unique id in system.

    Example: OHXTEF9M
    currencystringrequired

    Currency payout

    Example: PHP
    payout_method_namestringrequired
    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[]required
  • Array [
    • uuidstringrequired
    Example: 1N49HDM2
    balance_idstringrequired

    Balance transaction UUID

    Example: 94AFB7D6-QVIA6QU0
    payeestringrequired

    Payee name

    Example: John Scarlet
    amountstringrequired

    Amount to charge payment.

    Example: 100.00
    external_idstring

    Custom ID

    Example: 123
    payout_method_paramsobjectrequired

    Required parameters for each 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_idstring

    Custom ID

    Example: 123

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
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/payouts/detail");
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
Parameters
— queryrequired
ResponseClear

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