> ## Documentation Index > Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt > Use this file to discover all available pages before exploring further. # Get PayIn methods > This API enables you to receive a list of all available payin methods. The app-id and secret-key will be used to determine the necessary payin methods based on the country and currency. You can configure this information in the Hello Clever Merchant Dashboard. ## OpenAPI ````yaml /api/openapi/v3-reference.yaml get /v3/payin_methods openapi: 3.0.2 info: title: Multi-currency Gateway description: "\n---\n\n## Introduction\n\nThe Multi-currency Gateway APIs have been designed to simplify how merchants manage payments across different currencies and methods. All transactions are processed directly through our gateway, ensuring a seamless experience while minimising the effort required for integration.\n\n👉 **Demo:** [View Demo Website](https://minimoo.cleverpay.store/)\n\n### Key Features\n\n- **Unified API Schema**: Handle multiple currencies through a single, consistent schema.\n- **Multi-Currency Support**: Accept and process payments in multiple currencies seamlessly.\n- **Currency-Aware Payment Methods**: Automatically present the supported payment options based on the transaction currency.\n- **Fast Onboarding**: Minimal setup effort with standardised API requests and responses.\n\n---\n\n## Integrate Multi-currency Gateway APIs into your website\n\n### 1. Payment Method\n\nUse this API to integrate and display all payment methods directly on your website. It’s the fastest option, as you won’t need to build or manage the payment method UI yourself.\n\n![Select payment methods](/img/multi-currency-gateway/select-payment-methods.png)\n\n- **Step 1**\_Call the Get PayIn Methods API\_to retrieve the list of available methods. (You may display this list directly in your UI.)\n- **Step 2**\_Call the\_Create PayIn API\_with the selected\_`payin_method_code`\_from Step 1.\n- **Step 3**\_The customer completes checkout\_on the Hello Clever hosted checkout page.\n- **Step 4** Wait for the webhook notification from Hello Clever and update the transaction status in your system accordingly.\n\n---\n\n### 2. Payment Link (Hello Clever brand)\n\nUse this API to integrate and run your own payment gateway. Use our Payment Link API (Hello Clever branded) to start collecting payments in no time, we’ll handle the rest of the checkout experience for you.\n\n![Payment link Hello Clever domain](/img/multi-currency-gateway/payment-link-hello-clever-domain.png)\n\n- **Step 1** Call the Create PayIn API without the `payin_method_code` field.\n- **Step 2**\_Redirect the customer to the generated\_`payment_url`.\n- **Step 3**\_The customer completes checkout by selecting from\_**all available payment methods**\_on the Hello Clever hosted checkout page.\n- **Step 4** Wait for the webhook notification from Hello Clever and update the transaction status in your system accordingly.\n\n---\n\n### 3. Payment Link (Your brand)\n\nPlease get in touch with [support@helloclever.co](mailto:support@helloclever.co) to customise your brand\n\n![Payment link custom domain](/img/multi-currency-gateway/payment-link-custom-domain.png)\n\n---\n\n## Integrate Multi-currency Gateway APIs with UX Control\n\n### 1. Redirect UX\n\nAfter receiving the `payment_url` from the Create PayIn API, redirect the user to that URL to complete the payment.\n\n**NOTE**: Some browsers (such as Safari, Chrome, etc.) block redirect functionality, preventing automatic redirection to the Payment Link. You need to allow pop-ups in your browser settings [here](#troubleshooting).\n\n**Example**:\n\n![Redirect UX](/img/multi-currency-gateway/redirect-ux.png)\n\n---\n\n### 2. Popup UX\n\nAfter receiving the `payment_url` from the Create PayIn API, render it inside a pop-up window so the user can complete the payment without leaving your site.\n\n**Example**:\n\n![Popup UX](/img/multi-currency-gateway/popup-ux.png)\n\nIn the Popup option, you can control for handling of payment success or failure events for closing the pop-up accordingly. This guide shows you how.\n\n---\n\n### Handle Payment Events in Popup UX\n\n_Listen to payment success or failure events to trigger your logic and close the pop-up when the transaction is completed._\n\n```jsx\nwindow.addEventListener(\"message\", function (event) {\n if (\n !event.data?.hc_payment_event ||\n typeof event.data?.hc_payment_event !== \"object\"\n )\n return;\n\n // Check the event type\n if (event.data.hc_payment_event.event_type === \"onChange\") {\n if (event.data.hc_payment_event.page_state === \"success\") {\n // Handle your logic here\n // E.g: If you want to redirect the main page to the success URL\n // window.location.href = event.data.hc_payment_event.redirect_url.success;\n }\n\n if (event.data.hc_payment_event.page_state === \"failed\") {\n // Handle your logic here\n // E.g: If you want to redirect the main page to the failure URL\n // window.location.href = event.data.hc_payment_event.redirect_url.failure;\n }\n }\n});\n```\n\n**Event data object**\n\n- `event_type`: The type of event triggered by the payment link\n - `onChange`: Triggered when the payment link state changes. This occurs when the `page_state` is success or failed page, or when the countdown reaches 0.\n - `onDone` : Triggered when the **Done** button is clicked on the success page; or when the countdown counts to 0.\n ![Popup Success](/img/multi-currency-gateway/popup-success.png)\n- `page_state`: The current state of the payment link\n - `success`: when the payment link is on the success page\n - `failed`: when the payment link is on the failed page\n\n```jsx\n// Data format\nhc_payment_event {\n event_type: string, // \"onChange\" || \"onDone\"\n page_state: \"success\" | \"failed\"\n}\n```\n\n**Example:** If you want to control when the pop-up closes on successful or failed transactions.\n\n![Popup Success](/img/multi-currency-gateway/popup-success.png)\n\n**Best Practices**\n - Treat **webhooks** as the source of truth for payment status. \n - Use **event listener** only to improve UX (instant feedback, UI updates).\n\n---\n\n## Troubleshooting\n\n- Some browsers (such as Safari, Chrome, etc.) block redirect functionality, preventing automatic redirection to the Payment Link. You need to allow pop-ups in your browser settings.\n\n ![Popup Blocked 1](/img/multi-currency-gateway/popup-blocked-1.png)\n\n ![Popup Blocked 2](/img/multi-currency-gateway/popup-blocked-2.png)\n\n 1. Click Tab icon\n 2. Open “Settings for [DOMAIN]”\n\n ![Resolve Popup 1](/img/multi-currency-gateway/resolve-popup-1.png)\n\n 3. Allow “Pop-up Window Blocked”\n\n ![Resolve Popup 2](/img/multi-currency-gateway/resolve-popup-2.png)\n" version: 3.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: - app-id: [] secret-key: [] paths: /v3/payin_methods: get: tags: - PayIn summary: Get PayIn methods description: >- This API enables you to receive a list of all available payin methods. The app-id and secret-key will be used to determine the necessary payin methods based on the country and currency. You can configure this information in the Hello Clever Merchant Dashboard. parameters: - name: lang in: query required: false schema: type: string description: > Language code (ISO 639-1, e.g., en, vi, ja). Use this parameter to specify the display language of payin method names. If not provided, the default language configured for the merchant account will be used. responses: '200': description: OK content: application/json: schema: type: object properties: records: type: array items: type: object required: - currency - payin_method_code properties: currency: type: string description: Currency Code (ISO 4217, 3-char alphabetic code). payin_method_name: type: string description: The name of the payin method. payin_method_code: type: string description: The unique code identifier of the payin method. logo: type: string description: >- The URL pointing to the logo image of the payin method. min_amount: type: number description: >- The minimum transaction amount supported by the payin method. max_amount: type: number description: >- The minimum transaction amount supported by the payin method. supported_cards: type: array description: The brand of the card (e.g., Visa, MasterCard). items: type: string enum: - visa - mastercard - jcb - amex available_lang: type: array items: type: object required: - code - name properties: code: type: string description: Language code (ISO 639-1, e.g., en, vi, ja). name: type: string description: Display name of the language. selected_lang: type: string description: Currently selected language code for displaying texts. examples: AUD: summary: AUD value: records: - currency: AUD payin_method_code: au_card_aud payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.5 max_amount: null supported_cards: - visa - mastercard - amex - jcb - currency: AUD payin_method_code: au_payid_npp_aud payin_method_name: PayID logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/pay_id.png min_amount: 1 max_amount: null available_lang: - code: en name: English selected_lang: en PHP: summary: PHP value: records: - currency: PHP payin_method_code: ph_ewallet_gcash_php payin_method_name: GCash logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/gcash.png min_amount: 200 max_amount: 50000 - currency: PHP payin_method_code: ph_bank_maya_php payin_method_name: Maya logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/maya.png min_amount: 200 max_amount: 50000 - currency: PHP payin_method_code: ph_bank_php payin_method_name: Bank transfer logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_tranfer.png min_amount: 200 max_amount: 50000 - currency: PHP payin_method_code: ph_qrph_php payin_method_name: QR Ph logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/qrph.png min_amount: 100 max_amount: 50000 available_lang: - code: en name: English - code: tl name: Tagalog selected_lang: en IDR: summary: IDR value: records: - currency: IDR payin_method_code: id_bank_qris_idr payin_method_name: QRIS logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/qris.png min_amount: 1 max_amount: 10000000 - currency: IDR payin_method_code: id_ewallet_dana_idr payin_method_name: DANA logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/dana_wallet.png min_amount: 10000 max_amount: 2000000 available_lang: - code: en name: English - code: id name: Bahasa Indonesia selected_lang: en VND: summary: VND value: records: - currency: VND payin_method_code: vn_vietqr_vnd payin_method_name: VietQR logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/viet_qr.png min_amount: 100000 max_amount: 300000000 - currency: VND payin_method_code: vn_other_vietqr_vnd payin_method_name: VietQR logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/viet_qr.png min_amount: 1000000 max_amount: 299999999 - currency: VND payin_method_code: vn_ewallet_momo_vnd payin_method_name: Momo logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/momo.png min_amount: 10000 max_amount: 50000000 available_lang: - code: en name: English - code: vi name: Tiếng Việt selected_lang: en MYR: summary: MYR value: records: - currency: MYR payin_method_code: my_ewallet_touchngo_myr payin_method_name: Touch 'n Go logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/touchngo.png min_amount: 5 max_amount: 100000000 - currency: MYR payin_method_code: my_bank_duitnow_myr payin_method_name: DuitNow logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/duit_now.png min_amount: 1 max_amount: 9999999 - currency: MYR payin_method_code: my_ewallet_boost_myr payin_method_name: Boost logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/boost.png min_amount: 5 max_amount: 100000000 - currency: MYR payin_method_code: my_ewallet_grabpay_myr payin_method_name: GrabPay logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/grab_pay.png min_amount: 5 max_amount: 100000000 - currency: MYR payin_method_code: my_bank_fpx_myr payin_method_name: FPX logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/fpx.png min_amount: 1 max_amount: 1000000 - currency: MYR payin_method_code: my_ewallet_shopeepay_myr payin_method_name: ShopeePay logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/shopee_pay.png min_amount: 1 max_amount: 100000000 available_lang: - code: en name: English - code: ms name: Bahasa Melayu selected_lang: en JPY: summary: JPY value: records: - currency: JPY payin_method_code: jp_bank_jpy payin_method_name: Bank transfer logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_tranfer.png min_amount: null max_amount: null - currency: JPY payin_method_code: jp_card_jpy payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.5 max_amount: null supported_cards: - visa - mastercard - amex - jcb available_lang: - code: en name: English - code: ja name: 日本語 selected_lang: en CAD: summary: CAD value: records: - currency: CAD payin_method_code: ca_interac_cad payin_method_name: Interac logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/interac.png min_amount: 30 max_amount: 50000 available_lang: - code: en name: English selected_lang: en NGN: summary: NGN value: records: - currency: NGN payin_method_code: ng_bank_ngn payin_method_name: Bank transfer logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_transfer.png min_amount: 100 max_amount: 1000000 available_lang: - code: en name: English selected_lang: en KES: summary: KES value: records: - currency: KES payin_method_code: ke_mobile_money_kes payin_method_name: M-PESA logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/m_pesa.png min_amount: 10 max_amount: 50000 available_lang: - code: en name: English selected_lang: en GHS: summary: GHS value: records: - currency: GHS payin_method_code: gh_mobile_money_ghs payin_method_name: M-PESA logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/m_pesa.png min_amount: 10 max_amount: 5000 available_lang: - code: en name: English selected_lang: en ZAR: summary: ZAR value: records: - currency: ZAR payin_method_code: sa_eft_zar payin_method_name: EFT logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/eft.png min_amount: 2 max_amount: 500000 available_lang: - code: en name: English selected_lang: en XAF: summary: XAF value: records: - currency: XAF payin_method_code: cm_mobile_money_xaf payin_method_name: M-PESA logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/m_pesa.png min_amount: 1500 max_amount: 500000 available_lang: - code: en name: English - code: fr name: Français selected_lang: en XOF: summary: XOF value: records: - currency: XOF payin_method_code: ci_mobile_money_xof payin_method_name: M-PESA logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/m_pesa.png min_amount: 500 max_amount: 500000 available_lang: - code: en name: English - code: fr name: Français selected_lang: en BRL: summary: BRL value: records: - currency: BRL payin_method_code: br_pix_brl payin_method_name: Pix logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/pix.png min_amount: 1 max_amount: 15000 available_lang: - code: en name: English - code: pt name: Português selected_lang: en THB: summary: THB value: records: - currency: THB payin_method_code: th_qrpay_thb payin_method_name: Thai QR logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/thai_qr.png min_amount: 100 max_amount: 2000000 available_lang: - code: en name: English - code: th name: ภาษาไทย selected_lang: en KRW: summary: KRW value: records: - currency: KRW payin_method_code: kr_bank_krw payin_method_name: Bank transfer logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_transfer.png min_amount: 10000 max_amount: 50000000 available_lang: - code: en name: English - code: ko name: 한국어 selected_lang: en INR: summary: INR value: records: - currency: INR payin_method_code: in_upi_inr payin_method_name: UPI ID logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/deep_link.png min_amount: 0 max_amount: null available_lang: - code: en name: English - code: hi name: हिन्दी selected_lang: en EUR: summary: EUR value: records: - currency: EUR payin_method_code: eu_card_eur payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.5 max_amount: null supported_cards: - visa - mastercard - amex - jcb available_lang: - code: en name: English selected_lang: en USD: summary: USD value: records: - currency: USD payin_method_code: us_card_usd payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.5 max_amount: null supported_cards: - visa - mastercard - amex - jcb available_lang: - code: en name: English selected_lang: en ARS: summary: ARS value: records: - currency: ARS payin_method_code: ar_bank_ars payin_method_name: Pay by Bank logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_tranfer.png min_amount: 2000 max_amount: 500000 - currency: ARS payin_method_code: ar_cvu_ars payin_method_name: Pay by Bank (CVU) logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_tranfer.png min_amount: 1500 max_amount: 13000000 available_lang: - code: en name: English - code: es-AR name: Español selected_lang: en BWP: summary: BWP value: records: - currency: BWP payin_method_code: bw_bank_bwp payin_method_name: Pay by Bank logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_transfer.png min_amount: 0 max_amount: null - currency: BWP payin_method_code: bw_mobile_money_bwp payin_method_name: Mobile Money logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/mobile_money.png min_amount: 0 max_amount: null available_lang: - code: en name: English - code: tn-BW name: Setswana selected_lang: en MWK: summary: MWK value: records: - currency: MWK payin_method_code: mw_mobile_money_mwk payin_method_name: Mobile Money logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/mobile_money.png min_amount: 2000 max_amount: null - currency: MWK payin_method_code: mw_bank_mwk payin_method_name: Bank Transfer logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/bank_transfer.png min_amount: 2000 max_amount: null available_lang: - code: en name: English selected_lang: en NZD: summary: NZD value: records: - currency: NZD payin_method_code: nz_card_nzd payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.01 max_amount: 10000 supported_cards: - visa - mastercard - amex - jcb available_lang: - code: en name: English selected_lang: en HKD: summary: HKD value: records: - currency: HKD payin_method_code: hk_card_hkd payin_method_name: Debit or Credit Card logo: >- https://aircrexlandingpageprod.azureedge.net/static/clever/pgv3/payment_methods/card_default.png min_amount: 0.01 max_amount: 10000 supported_cards: - visa - mastercard - amex - jcb available_lang: - code: en name: English - code: zh-Hant-HK name: 繁體中文 (香港) selected_lang: en '400': description: Bad Request '401': description: Unauthorized content: application/json: schema: type: object properties: errors: type: object properties: code: type: string message: type: string example: errors: code: REQUIRE_LOGIN message: Not Authorised '422': description: Unprocessable Entity content: application/json: schema: type: object properties: errors: type: object properties: message: type: string example: errors: message: Invalid language components: securitySchemes: app-id: type: apiKey in: header name: app-id description: | A unique identifier assigned to each application. secret-key: type: apiKey in: header name: secret-key description: | A secure token associated with the `app-id`. ```` ## Related topics - [Create PayIn](/api/payin/create-payin.md) - [Get Payin Methods](/api/payin-methods/get-payin-methods.md) - [Multi-Currency Payin API Reference (v2)](/api/v2/payin.md)