Get Payin’s Required Fields

GET 
https://api.cleverhub.co/api/v2/payins/payin_method/params

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

Request

Query Parameters

payin_method_name stringrequired

Payin Method Name (For e.g. ph_bank_maya_php)

Responses

200

OK

application/json

Schema

Schema

record object

currencystringrequired

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

symbolstring

Currency symbol.

logostring

Bank or e-wallet logo.

payin_method_namestringrequired

Payin method name.

descriptionstringrequired

Description payin method.

payin_method_paramsobjectrequired

Parameters needed for using a payin method. Each payin method may have different parameters, which can be either mandatory or optional.

payment_typestringrequired

Type of payment, incoming or outgoing.

is_refundableboolean

Refundable or not.

min_amountnumberrequired

The minimum allowable amount.

max_amountnumberrequired

The maximum allowable amount.

Example (auto)

{
  "record": {
    "currency": "string",
    "symbol": "string",
    "logo": "string",
    "payin_method_name": "string",
    "description": "string",
    "payin_method_params": {},
    "payment_type": "string",
    "is_refundable": true,
    "min_amount": 0,
    "max_amount": 0
  }
}

AUD PayID NPP

AUD PayID NPP

{
  "record": {
    "currency": "AUD",
    "symbol": "$",
    "logo": "",
    "payin_method_name": "au_payid_npp_aud",
    "description": "New Payments Platform (NPP)",
    "payin_method_params": {
      "callback_url": "string:Mandatory callback URL"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": true,
    "require_kyc": false,
    "min_amount": 20,
    "max_amount": 10000
  }
}

PHP Bank Maya

PHP Bank Maya

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payin_method_name": "ph_bank_maya_php",
    "description": "MAYA",
    "payin_method_params": {
      "user_id": "string:Optional user ID from the merchant system",
      "product_name": "string:Optional product names from the merchant system"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 200,
    "max_amount": 50000
  }
}

PHP GCash eWallet

PHP GCash eWallet

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payin_method_name": "ph_ewallet_gcash_php",
    "description": "GCASH",
    "payin_method_params": {
      "user_id": "string:Optional user ID from the merchant system",
      "product_name": "string:Optional product names from the merchant system"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 200,
    "max_amount": 50000
  }
}

PHP Bank Transfer

PHP Bank Transfer

{
  "record": {
    "currency": "PHP",
    "symbol": "₱",
    "logo": "",
    "payin_method_name": "ph_bank_php",
    "description": "Bank Transfer",
    "payin_method_params": {
      "callback_url": "string:Mandatory",
      "bank_code": "string:Mandatory Enum(bdo,bpi,landbank,metrobank,qrph,ubp)"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": true,
    "require_kyc": false,
    "min_amount": 200,
    "max_amount": 200000
  }
}

IDR Bank QRIS

IDR Bank QRIS

{
  "record": {
    "currency": "IDR",
    "symbol": "Rp",
    "logo": "",
    "payin_method_name": "id_bank_qris_idr",
    "description": "Quick Response Code Indonesian Standard",
    "payin_method_params": {
      "callback_url": "string:Optional redirect URL for the payment gateway to redirect to after payment",
      "user_id": "string:Optional user ID from the merchant system",
      "account_name": "string:Optional account name from the merchant system",
      "product_name": "string:Optional product names from the merchant system"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 10000000
  }
}

IDR DANA eWallet

IDR DANA eWallet

{
  "record": {
    "currency": "IDR",
    "symbol": "Rp",
    "logo": "",
    "payin_method_name": "id_ewallet_dana_idr",
    "description": "DANA",
    "payin_method_params": {
      "callback_url": "string:Mandatory"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 1,
    "max_amount": 10000000
  }
}

VND Other Viet QR

VND Viet QR

{
  "record": {
    "currency": "VND",
    "symbol": "₫",
    "logo": "",
    "payin_method_name": "vn_other_vietqr_vnd",
    "description": "VietQR",
    "payin_method_params": {
      "user_id": "string:Optional user ID from the merchant system",
      "account_name": "string:Optional account name from the merchant system",
      "product_name": "string:Optional product names from the merchant system"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100000,
    "max_amount": 5000000000
  }
}

VND Viet QR

VND Viet QR

{
  "record": {
    "currency": "VND",
    "symbol": "₫",
    "logo": "",
    "payin_method_name": "vn_vietqr_vnd",
    "description": "VietQR V2",
    "payin_method_params": {
      "ip_address": "string:Mandatory Ip address of customer",
      "phone": "string:Mandatory Phone number of customer"
    },
    "payment_type": "pay_in",
    "is_refundable": true,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10000,
    "max_amount": 300000000
  }
}

VND Momo eWallet

VND Momo eWallet

{
  "record": {
    "currency": "VND",
    "symbol": "₫",
    "logo": "",
    "payin_method_name": "vn_ewallet_momo_vnd",
    "description": "MOMO",
    "payin_method_params": {
      "user_id": "string:Optional user ID from the merchant system",
      "account_name": "string:Optional account name from the merchant system"
    },
    "payment_type": "pay_in",
    "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": "",
    "payin_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.",
    "payin_method_params": {
      "user_id": "string:Optional user ID from the merchant system",
      "account_name": "string:Mandatory DuitNow Name",
      "product_name": "string:Optional product names from the merchant system"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 500,
    "max_amount": 50000
  }
}

MYR Bank FPX

MYR Bank FPX

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payin_method_name": "my_bank_fpx_myr",
    "description": "FPX Banking.",
    "payin_method_params": {
      "bank_type": "string:Mandatory '01' retail banking or '02' corporate banking",
      "bank_code": "string:Mandatory recipient's bank code",
      "callback_url": "string:Mandatory"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 500,
    "max_amount": 50000
  }
}

MYR Boost eWallet

MYR Boost eWallet

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payin_method_name": "my_ewallet_boost_myr",
    "description": "Boost eWallet.",
    "payin_method_params": {},
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 5,
    "max_amount": 100000000
  }
}

MYR ShopeePay eWallet

MYR ShopeePay eWallet

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payin_method_name": "my_ewallet_shopeepay_myr",
    "description": "ShopeePay eWallet.",
    "payin_method_params": {},
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 5,
    "max_amount": 100000000
  }
}

MYR Touch 'n Go eWallet

MYR Touch 'n Go eWallet

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payin_method_name": "my_ewallet_touchngo_myr",
    "description": "Touch 'n Go eWallet.",
    "payin_method_params": {},
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 5,
    "max_amount": 100000000
  }
}

MYR GrabPay eWallet

MYR GrabPay eWallet

{
  "record": {
    "currency": "MYR",
    "symbol": "RM",
    "logo": "",
    "payin_method_name": "my_ewallet_grabpay_myr",
    "description": "GrabPay eWallet.",
    "payin_method_params": {},
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 5,
    "max_amount": 100000000
  }
}

JPY Bank Transfer

JPY Bank Transfer

{
  "record": {
    "currency": "JPY",
    "symbol": "¥",
    "logo": "",
    "payin_method_name": "jp_bank_jpy",
    "description": "Bank Transfer",
    "payin_method_params": {
      "user_id": "string:Mandatory the unique ID of the customer",
      "ip_address": "string:Mandatory customer device IP",
      "first_name": "string:Mandatory",
      "last_name": "string:Mandatory"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 1,
    "max_amount": 1000000
  }
}

USDC Bank

USDC Bank

{
  "record": {
    "currency": "USDC",
    "symbol": "USDC",
    "logo": "",
    "payin_method_name": "usdc_bank",
    "description": "Bank Transfer",
    "payin_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_in",
    "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": "",
    "payin_method_name": "ca_interac_cad",
    "description": "Interac e-Transfer",
    "payin_method_params": {
      "callback_url": "string:Mandatory"
    },
    "payment_type": "pay_in",
    "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": "",
    "payin_method_name": "ng_bank_ngn",
    "description": "Bank Transfer",
    "payin_method_params": {},
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100,
    "max_amount": 1000000
  }
}

KES Mobile Money

KES Mobile Money

{
  "record": {
    "currency": "KES",
    "symbol": "KSh",
    "logo": "",
    "payin_method_name": "ke_mobile_money_kes",
    "description": "Mobile Money",
    "payin_method_params": {
      "account_number": "string:Mandatory mobile money account number"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10,
    "max_amount": 50000
  }
}

GHS Mobile Money

GHS Mobile Money

{
  "record": {
    "currency": "GHS",
    "symbol": "GH₵",
    "logo": "",
    "payin_method_name": "gh_mobile_money_ghs",
    "description": "Mobile Money",
    "payin_method_params": {
      "account_number": "string:Mandatory mobile money account number"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10,
    "max_amount": 5000
  }
}

ZAR Instant EFT

ZAR Instant EFT

{
  "record": {
    "currency": "ZAR",
    "symbol": "R",
    "logo": "",
    "payin_method_name": "sa_eft_zar",
    "description": "Bank Transfer",
    "payin_method_params": {
      "bank_code": "string:Mandatory bank code for the charge"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 2,
    "max_amount": 500000
  }
}

XAF Mobile Money

XAF Mobile Money

{
  "record": {
    "currency": "XAF",
    "symbol": "FCFA",
    "logo": "",
    "payin_method_name": "cm_mobile_money_xaf",
    "description": "Mobile Money",
    "payin_method_params": {
      "account_number": "string:Mandatory mobile money account number"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 500,
    "max_amount": 500000
  }
}

XOF Mobile Money

XOF Mobile Money

{
  "record": {
    "currency": "XOF",
    "symbol": "CFA",
    "logo": "",
    "payin_method_name": "ci_mobile_money_xof",
    "description": "Mobile Money",
    "payin_method_params": {
      "account_number": "string:Mandatory mobile money account number"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 500,
    "max_amount": 500000
  }
}

BRL PIX

BRL PIX

{
  "record": {
    "currency": "BRL",
    "symbol": "R$",
    "logo": "",
    "payin_method_name": "br_pix_brl",
    "description": "PIX",
    "payin_method_params": {
      "callback_url": "string:Mandatory",
      "document_type": "string:Mandatory Enum(CPF, CNPJ)",
      "document_number": "string:Mandatory Regex:/^\\d{11,14}$/",
      "crypto_ticker": "string:Optional Crypto ticker of the above specified wallet address. Example: USDC, USDT, BTC...",
      "crypto_wallet_address": "string:Optional The wallet dddress corresponding to the specified crypto ticker"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 1,
    "max_amount": 15000
  }
}

THB ThaiQR

THB ThaiQR

{
  "record": {
    "currency": "THB",
    "symbol": "฿",
    "logo": "",
    "payin_method_name": "th_qrpay_thb",
    "description": "QR Pay",
    "payin_method_params": {
      "payer_account_no": "string:Mandatory your paying bank account no",
      "payer_account_name": "string: Mandatory your paying bank account name",
      "payer_bank_code": "string:Mandatory payer's bank code",
      "callback_url": "string:Mandatory callback URL"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 100,
    "max_amount": 2000000
  }
}

KRW Bank Transfer

KRW Bank Transfer

{
  "record": {
    "currency": "KRW",
    "symbol": "₩",
    "logo": "",
    "payin_method_name": "kr_bank_krw",
    "description": "Bank Transfer",
    "payin_method_params": {
      "user_name": "string:Mandatory the name of the user"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 10000,
    "max_amount": 10000000
  }
}

INR UPI

INR UPI

{
  "record": {
    "currency": "INR",
    "symbol": "₹",
    "logo": "",
    "payin_method_name": "in_upi_inr",
    "description": "Unified Payments Interface (UPI)",
    "payin_method_params": {
      "upi_id": "string:Mandatory UPI ID",
      "first_name": "string:Mandatory first name of the user",
      "last_name": "string:Mandatory last name of the user",
      "phone": "string:Mandatory phone number of the user",
      "country": "string:Mandatory ISO 3166-1 alpha-2 code",
      "state": "string:Mandatory State",
      "address": "string:Mandatory address of the user",
      "city": "string:Mandatory city of the user",
      "postal_code": "string:Mandatory Postal code of the user",
      "email": "string:Mandatory email address of the user",
      "callback_url": "string:Mandatory callback URL"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false
  }
}

ARS Bank Transfer

ARS Bank Transfer

{
  "record": {
    "currency": "ARS",
    "symbol": "AR$",
    "logo": "",
    "payin_method_name": "ar_bank_ars",
    "description": "Bank Transfer",
    "payin_method_params": {
      "user_id": "string:Mandatory",
      "ip_address": "string:Mandatory",
      "first_name": "string:Mandatory First Name",
      "last_name": "string:Mandatory Last Name"
    },
    "payment_type": "pay_in",
    "is_refundable": false,
    "is_cancellable": false,
    "require_contact": false,
    "require_kyc": false,
    "min_amount": 2000,
    "max_amount": 500000
  }
}

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

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/payins/payin_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

payin_method_name — queryrequired

ResponseClear

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