Get payout required fields

GET 
https://api.cleverhub.co/api/v2/payouts/payout_method/params

Certain payout methods may require information to be collected from consumers. This API will provide all the parameters potentially needed for a specific payout method. The returned parameters could be either optional or mandatory.

Request

Query Parameters

payout_method_name stringrequired

Payout method name

Responses

200

OK

application/json

Schema

Schema

record object

currencystringrequired

Currency Code (ISO 4217, 3-char alphabetic code).

symbolstring

Currency symbol.

logostring

Bank or ewallet logo.

payout_method_namestringrequired

Payout method name

descriptionstringrequired

Description payin method.

payment_typestringrequired

Type of payment, incoming or outgoing.

payout_method_paramsobjectrequired

Params need using payout method.Each payment method may have different parameters, which can be either mandatory or optional.

banks object[]required

Array [

codestringrequired

Identification of the bank

namestringrequired

Bank name

short_namestring

Bank short name

]

min_amountnumberrequired

The minimum allowable amount.

max_amountnumberrequired

The maximum allowable amount.

Example (auto)

{
  "record": {
    "currency": "string",
    "symbol": "string",
    "logo": "string",
    "payout_method_name": "string",
    "description": "string",
    "payment_type": "string",
    "payout_method_params": {},
    "banks": [
      {
        "code": "string",
        "name": "string",
        "short_name": "string"
      }
    ],
    "min_amount": 0,
    "max_amount": 0
  }
}

PHP Bank Maya

PHP Bank Maya

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payout_method_name": "ph_bank_maya_php",
    "description": "MAYA",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 200,
    "max_amount": 50000
  }
}

PHP EWallet GCash

PHP EWallet GCash

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payout_method_name": "ph_ewallet_gcash_php",
    "description": "GCASH",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "min_amount": 200,
    "max_amount": 50000
  }
}

PHP Bank Transfer

PHP Bank Transfer

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payout_method_name": "ph_bank_php",
    "description": "Bank Transfer",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "bank_code": "string:Mandatory Bank Code, please check the list of banks: https://helloclever.azureedge.net/hellocleverweb-staging/clever/section/php/php_banks.json"
    },
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": true,
    "require_kyc": false,
    "min_amount": 100,
    "max_amount": 50000
  }
}

IDR Bank QRIS

IDR Bank QRIS

{
  "record": {
    "currency": "IDR",
    "symbol": "Rp",
    "logo": "",
    "payout_method_name": "id_bank_qris_idr",
    "description": "Quick Response Code Indonesian Standard",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 10000000
  }
}

IDR Bank

IDR Bank

{
  "record": {
    "currency": "IDR",
    "symbol": "Rp",
    "logo": "",
    "payout_method_name": "id_bank_idr",
    "description": "Bank Transfer",
    "payout_method_params": {
      "bank_name": "string:Mandatory recipient's bank name",
      "account_name": "string:Mandatory recipient's bank account name",
      "account_number": "string:Mandatory recipient's bank account number",
      "description": "string:Mandatory description for the transfer"
    },
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 10000000
  }
}

VND Viet QR

VND Viet QR

{
  "record": {
    "currency": "VND",
    "symbol": "₫",
    "logo": "",
    "payout_method_name": "vn_other_vietqr_vnd",
    "description": "VietQR",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 5000000000
  }
}

VND Momo Ewallet

VND Momo Ewallet

{
  "record": {
    "currency": "VND",
    "symbol": "₫",
    "logo": "",
    "payout_method_name": "vn_ewallet_momo_vnd",
    "description": "MOMO",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 50000000
  }
}

MYR Bank Duitnow

MYR Bank Duitnow

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payout_method_name": "my_bank_duitnow_myr",
    "description": "Simple and convenient way of transferring money using easy-to-remember DuitNow IDs such as mobile number and NRIC number.",
    "payout_method_params": {
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Account Holder Name",
      "bank_code": "string:Mandatory Bank Code"
    },
    "banks": [
      {
        "code": "600",
        "name": "GCASH",
        "short_name": null
      }
    ],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 500,
    "max_amount": 50000
  }
}

MYR Bank Transfer

MYR Bank Transfer

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payout_method_name": "my_bank_myr",
    "description": "Bank Transfer.",
    "payout_method_params": {
      "bank_name": "string:Mandatory recipient's bank name",
      "bank_code": "string:Mandatory recipient's bank code",
      "account_number": "string:Mandatory recipient's bank account number",
      "account_name": "string:Mandatory recipient's bank account name",
      "business_reg_no": "string:Mandatory merchant's business registration number"
    },
    "banks": [],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10,
    "max_amount": 100000000
  }
}

MYR Ewallet Transfer

MYR Ewallet Transfer

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payout_method_name": "my_ewallet_*_myr",
    "description": "Bank Transfer.",
    "payout_method_params": {
      "bank_code": "string:Mandatory recipient's bank code",
      "account_number": "string:Mandatory recipient's mobile number include the country code '60' (Malaysia's country code)",
      "account_name": "string:Mandatory recipient's account name",
      "business_reg_no": "string:Mandatory merchant's business registration number"
    },
    "banks": [],
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10,
    "max_amount": 100000000
  }
}

JPY Bank Transfer

JPY Bank Transfer

{
  "record": {
    "currency": "JPY",
    "symbol": "¥",
    "logo": "",
    "payout_method_name": "jp_bank_jpy",
    "description": "Bank Transfer",
    "payout_method_params": {
      "user_id": "string:Mandatory the unique ID of the customer",
      "ip_address": "string:Mandatory customer device IP",
      "phone": "string:Mandatory",
      "bank_name": "string:Mandatory recipient's bank name",
      "bank_code": "string:Mandatory recipient's bank code",
      "branch_name": "string:Mandatory recipient's bank branch name",
      "branch_code": "string:Mandatory recipient's bank branch code",
      "account_number": "string:Mandatory recipient's bank account number",
      "account_name": "string:Mandatory bank account owner's name (in Katakana)",
      "native_account_name": "string:Mandatory bank account owner's name (in Kanji)",
      "account_type": "string:Mandatory Enum(ordinary, savings, current, other)"
    }
  },
  "payment_type": "pay_out",
  "is_refundable": false,
  "is_cancellable": false,
  "require_contact": false,
  "require_kyc": false,
  "min_amount": 1,
  "max_amount": 17000000
}

USDC Bank

USDC Bank

{
  "record": {
    "currency": "USDC",
    "symbol": "USDC",
    "logo": "",
    "payout_method_name": "usdc_bank",
    "description": "Bank Transfer",
    "payout_method_params": {
      "original_currency": "string:Mandatory Enum(USD, GBP, EUR) - input specific original currency and combine with original amount",
      "original_amount": "number:Mandatory - input specific original amount, the system uses this field to payin",
      "callback_url": "string:Mandatory"
    },
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 1,
    "max_amount": 9999999
  }
}

Interac CAD

Interac CAD

{
  "record": {
    "currency": "CAD",
    "symbol": "CAD",
    "logo": "",
    "payout_method_name": "ca_interac_cad",
    "description": "Interac e-Transfer",
    "payout_method_params": {
      "email": "string:Mandatory",
      "purpose_code": "string:Optional Enum(expense_or_medical_reimbursement, fee_payments, payroll_processing, transaction_between_banks, services_related_to_financial_trade_travel_or_accounting, transportation_costs, software_export_or_development, personal, other)",
      "beneficiary_email": "string:Mandatory email of the beneficiary",
      "security_question": "string:Mandatory security question",
      "security_answer": "string:Mandatory security answer"
    },
    "payment_type": "pay_out",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": true,
    "require_kyc": true,
    "min_amount": 34,
    "max_amount": 50000
  }
}

NGN Bank Transfer

NGN Bank Transfer

{
  "record": {
    "currency": "NGN",
    "symbol": "₦",
    "logo": "",
    "payout_method_name": "ng_bank_ngn",
    "description": "Bank Transfer",
    "payment_type": "pay_out",
    "payout_method_params": {
      "bank_code": "string:Mandatory",
      "account_number": "string:Mandatory Bank Account Number"
    },
    "banks": [],
    "min_amount": 100,
    "max_amount": 10000000,
    "require_contact": false,
    "require_kyc": false
  }
}

KES Bank Transfer

KES Bank Transfer

{
  "record": {
    "currency": "KES",
    "symbol": "KSh",
    "logo": "",
    "payout_method_name": "ke_bank_kes",
    "description": "Bank Transfer",
    "payment_type": "pay_out",
    "payout_method_params": {
      "bank_code": "string:Mandatory",
      "account_number": "string:Mandatory Bank Account Number"
    },
    "banks": [],
    "min_amount": 10,
    "max_amount": 85000,
    "require_contact": false,
    "require_kyc": false
  }
}

KES Mobile Money

KES Mobile Money

{
  "record": {
    "currency": "KES",
    "symbol": "KSh",
    "logo": "",
    "payout_method_name": "ke_mobile_money_kes",
    "description": "Mobile Money",
    "payment_type": "pay_out",
    "payout_method_params": {
      "account_number": "string:Mandatory mobile money account number",
      "mobile_money_operator": "string:Mandatory mobile money operator"
    },
    "banks": [],
    "min_amount": 10,
    "max_amount": 85000,
    "require_contact": false,
    "require_kyc": false
  }
}

GHS Mobile Money

GHS Mobile Money

{
  "record": {
    "currency": "GHS",
    "symbol": "GH₵",
    "logo": "",
    "payout_method_name": "gh_mobile_money_ghs",
    "description": "Mobile Money",
    "payment_type": "pay_out",
    "payout_method_params": {
      "account_number": "string:Mandatory mobile money account number",
      "mobile_money_operator": "string:Mandatory mobile money operator"
    },
    "banks": [],
    "min_amount": 10,
    "max_amount": 10000,
    "require_contact": false,
    "require_kyc": false
  }
}

ZAR Bank Transfer

ZAR Bank Transfer

{
  "record": {
    "currency": "ZAR",
    "symbol": "R",
    "logo": "",
    "payout_method_name": "sa_bank_zar",
    "description": "Bank Transfer",
    "payment_type": "pay_out",
    "payout_method_params": {
      "bank_code": "string:Mandatory",
      "account_number": "string:Mandatory Bank Account Number",
      "account_name": "string:Mandatory Bank Account Name"
    },
    "banks": [],
    "min_amount": 2,
    "max_amount": 500000,
    "require_contact": false,
    "require_kyc": false
  }
}

XAF Mobile Money

XAF Mobile Money

{
  "record": {
    "currency": "XAF",
    "symbol": "FCFA",
    "logo": "",
    "payout_method_name": "cm_mobile_money_xaf",
    "description": "Mobile Money",
    "payment_type": "pay_out",
    "payout_method_params": {
      "account_number": "string:Mandatory mobile money account number",
      "mobile_money_operator": "string:Mandatory mobile money operator"
    },
    "banks": [],
    "min_amount": 500,
    "max_amount": 500000,
    "require_contact": false,
    "require_kyc": false
  }
}

XOF Mobile Money

XOF Mobile Money

{
  "record": {
    "currency": "XOF",
    "symbol": "CFA",
    "logo": "",
    "payout_method_name": "ci_mobile_money_xof",
    "description": "Mobile Money",
    "payment_type": "pay_out",
    "payout_method_params": {
      "account_number": "string:Mandatory mobile money account number",
      "mobile_money_operator": "string:Mandatory mobile money operator"
    },
    "banks": [],
    "min_amount": 500,
    "max_amount": 500000,
    "require_contact": false,
    "require_kyc": false
  }
}

BRL PIX

BRL PIX

{
  "record": {
    "currency": "BRL",
    "symbol": "R$",
    "logo": "",
    "payout_method_name": "br_pix_brl",
    "description": "PIX",
    "payment_type": "pay_out",
    "payout_method_params": {
      "purpose_code": "string:Optional Enum(expense_or_medical_reimbursement, fee_payments, payroll_processing, transaction_between_banks, services_related_to_financial_trade_travel_or_accounting, transportation_costs, software_export_or_development, personal, other)",
      "document_type": "string:Mandatory Enum(CPF, CNPJ)",
      "document_number": "string:Mandatory Regex:/^\\d{11,14}$/",
      "account_name": "string:Mandatory Payer's name",
      "pixkey_type": "string:Mandatory Enum(CPF, EMAIL, PHONE)",
      "pix_key": "string:Mandatory",
      "beneficiary_type": "string:Mandatory Enum(individual, company)"
    },
    "banks": [],
    "min_amount": 1,
    "max_amount": 10000000,
    "require_contact": "true,",
    "require_kyc": false
  }
}

BRL Bank Transfer

BRL Bank Transfer

{
  "record": {
    "currency": "BRL",
    "symbol": "R$",
    "logo": "",
    "payout_method_name": "br_bank_brl",
    "description": "Bank Transfer",
    "payment_type": "pay_out",
    "payout_method_params": {
      "purpose_code": "string:Optional Enum(expense_or_medical_reimbursement, fee_payments, payroll_processing, transaction_between_banks, services_related_to_financial_trade_travel_or_accounting, transportation_costs, software_export_or_development, personal, other)",
      "document_type": "string:Mandatory Enum(CPF, CNPJ)",
      "document_number": "string:Mandatory Regex:/^\\d{11,14}$/",
      "account_number": "string:Mandatory",
      "bank_code": "string:Mandatory",
      "branch_code": "string:Mandatory",
      "account_type": "string:Mandatory Enum(checking, savings)"
    },
    "banks": [],
    "min_amount": 30,
    "max_amount": 10000,
    "require_contact": "true,",
    "require_kyc": false
  }
}

THB Bank Transfer

THB Bank Transfer

{
  "record": {
    "currency": "THB",
    "symbol": "฿",
    "logo": "",
    "payout_method_name": "th_bank_thb",
    "description": "Bank Transfer",
    "payment_type": "pay_out",
    "payout_method_params": {
      "bank_code": "String:Mandatory recipient's bank code",
      "description": "String:Mandatory description for the transfer",
      "account_number": "String:Mandatory recipient's bank account number"
    },
    "banks": [],
    "min_amount": 300,
    "max_amount": 2000000,
    "require_contact": false,
    "require_kyc": false
  }
}

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

422

Unprocessable Entity

application/json

Schema

Schema

errors object
payout_method_namestring

Example (auto)

{
  "errors": {
    "payout_method_name": "string"
  }
}

Example

{
  "errors": {
    "payout_method_name": "invalid"
  }
}

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

payout_method_name — queryrequired

ResponseClear

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