Get Payout Methods

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

This API enables you to receive a list of all available payout methods. The app-id and secret-key will be used to determine the necessary payout methods based on the country and currency. You can configure this information in the Hello Clever Merchant Dashboard.

Responses

200

OK

application/json

Schema

Schema

records object[]
Array [
currencystringrequired
Currency Code (ISO 4217, 3-char alphabetic code)
payout_method_namestringrequired
The name of the payout method.
]

Example (auto)

{
  "records": [
    {
      "currency": "string",
      "payout_method_name": "string"
    }
  ]
}

PHP

PHP

{
  "records": [
    {
      "currency": "PHP",
      "payout_method_name": "ph_bank_maya_php"
    },
    {
      "currency": "PHP",
      "payout_method_name": "ph_ewallet_gcash_php"
    },
    {
      "currency": "PHP",
      "payout_method_name": "ph_bank_php"
    }
  ]
}

IDR

IDR

{
  "records": [
    {
      "currency": "IDR",
      "payout_method_name": "id_bank_qris_idr"
    },
    {
      "currency": "IDR",
      "payout_method_name": "id_bank_idr"
    }
  ]
}

VND

VND

{
  "records": [
    {
      "currency": "VND",
      "payout_method_name": "vn_other_vietqr_vnd"
    },
    {
      "currency": "VND",
      "payout_method_name": "vn_ewallet_momo_vnd"
    },
    {
      "currency": "VND",
      "payout_method_name": "vn_bank_vnd"
    }
  ]
}

MYR

MYR

{
  "records": [
    {
      "currency": "MYR",
      "payout_method_name": "my_bank_duitnow_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_bank_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_bigpay_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_boost_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_shopee_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_merchantrade_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_finexus_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_gxbank_myr"
    },
    {
      "currency": "MYR",
      "payout_method_name": "my_ewallet_touchngo_myr"
    }
  ]
}

JPY

JPY

{
  "records": [
    {
      "currency": "JPY",
      "payout_method_name": "jp_bank_jpy"
    }
  ]
}

USDC

USDC

{
  "records": [
    {
      "currency": "USDC",
      "payout_method_name": "usdc_bank"
    }
  ]
}

CAD

CAD

{
  "records": [
    {
      "currency": "CAD",
      "payout_method_name": "ca_interac_cad"
    }
  ]
}

NGN

NGN

{
  "records": [
    {
      "currency": "NGN",
      "payout_method_name": "ng_bank_ngn"
    }
  ]
}

KES

KES

{
  "records": [
    {
      "currency": "KES",
      "payout_method_name": "ke_mobile_money_kes"
    },
    {
      "currency": "KES",
      "payout_method_name": "ke_bank_kes"
    }
  ]
}

GHS

GHS

{
  "records": [
    {
      "currency": "GHS",
      "payout_method_name": "gh_mobile_money_ghs"
    }
  ]
}

ZAR

ZAR

{
  "records": [
    {
      "currency": "ZAR",
      "payout_method_name": "sa_bank_zar"
    }
  ]
}

XAF

XAF

{
  "records": [
    {
      "currency": "XAF",
      "payout_method_name": "cm_mobile_money_xaf"
    }
  ]
}

XOF

XOF

{
  "records": [
    {
      "currency": "XOF",
      "payout_method_name": "ci_mobile_money_xof"
    }
  ]
}

BRL

BRL

{
  "records": [
    {
      "currency": "BRL",
      "payout_method_name": "br_pix_brl"
    },
    {
      "currency": "BRL",
      "payout_method_name": "br_bank_brl"
    }
  ]
}

THB

THB

{
  "records": [
    {
      "currency": "THB",
      "payout_method_name": "th_bank_thb"
    }
  ]
}

KRW

KRW

{
  "records": [
    {
      "currency": "KRW",
      "payout_method_name": "kr_bank_krw"
    }
  ]
}

INR

INR

{
  "records": [
    {
      "currency": "INR",
      "payout_method_name": "in_bank_inr"
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

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

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/payout_methods");
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

ResponseClear

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