# Hello Clever ## Docs - [Hello Clever Developer Documentation](https://docs.rc.cleverhub.co/index.md): REST APIs for real-time account-to-account payments, cards, multi-currency, and instant cashback, with webhooks, a full sandbox, and platform plugins. - [Get Started with Hello Clever](https://docs.rc.cleverhub.co/getting-started/overview.md): Real-time payments, payouts, cards, and instant cashback behind one integration. Pick the path that matches what you are building. - [What is Hello Clever?](https://docs.rc.cleverhub.co/getting-started/introduction.md): Hello Clever combines real-time payments, instant cashback rewards, and AI-powered insights into one platform built for merchants. - [How it works](https://docs.rc.cleverhub.co/getting-started/how-it-works.md): Learn how Hello Clever processes real-time payments, delivers instant cashback at checkout, and lets you configure flexible cashback campaigns. - [Industry Use Cases](https://docs.rc.cleverhub.co/getting-started/industry-use-cases.md): See how Hello Clever powers real-time payments and instant cashback across eCommerce, retail, platforms and marketplaces, travel, and the creator economy. - [Real-time Payin Service](https://docs.rc.cleverhub.co/services/real-time-payin.md): Accept instant account-to-account payments in Australia via PayID, BSB/Account, and PayTo, plus APAC real-time payment rail integrations. - [Payout Service: Send Funds to Recipients](https://docs.rc.cleverhub.co/services/payout.md): Send funds to recipients in Australia and across APAC using PayID, BSB/Account, or local bank transfers, with single, batch, and scheduled options. - [Instant Cashback for Your Customers](https://docs.rc.cleverhub.co/services/instant-cashback.md): Reward customers in real time at checkout using Hello Clever’s instant cashback platform, available both online and in-store via Tyro terminals. - [Card Payin Service: Accept Card Payments](https://docs.rc.cleverhub.co/services/card-payin.md): Accept Visa, Mastercard, Apple Pay, and Google Pay with tokenisation, PCI DSS Level 1 certified security, configurable surcharges, and Payments Account settlement. - [Multi-Currency FX Service](https://docs.rc.cleverhub.co/services/multi-currency-fx.md): Manage funds across AUD, JPY, and other currencies with dedicated Treasury Accounts, real-time FX conversion, and on-demand top-up and withdrawal. - [Settlement Service: Flexible Fund Access](https://docs.rc.cleverhub.co/services/settlement.md): Hello Clever’s Settlement Service offers instant, end-of-day, and on-demand fund access via Payments Accounts, cross-border settlement, and rolling reserves. - [Hello Clever Platform Overview](https://docs.rc.cleverhub.co/platform-overview/overview.md): How the Hello Clever platform fits together: merchant accounts, payment methods by market, balances and money movement, the Merchant Portal, Clever AI, and compliance. - [Create Your Hello Clever Merchant Account to Get Started](https://docs.rc.cleverhub.co/create-merchant-account.md): Sign up for a Hello Clever merchant account to access real-time payments, cashback campaigns, and the Merchant Portal via live or sandbox environments. - [Overview](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/overview.md): Understand the payment methods Hello Clever supports (real-time bank payments, recurring payments, and cards) across Australia, Japan, the United States, and beyond. - [Real-time A2A Payments in Depth](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/real-time-a2a.md): Learn how real-time account-to-account payments move money directly between bank accounts in seconds, and what makes them different. - [Real-time Payments vs. Card Payments](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/rtp-vs-cards.md): Compare real-time account-to-account payments with card payments across speed, cost, disputes, and data, and learn when to use each. - [Push vs. Pull Payments](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/push-vs-pull.md): Understand the difference between push payments (credit transfers, where the customer sends money) and pull payments (direct debits, where the business collects it). - [How Card Payments Work](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/how-cards-work.md): A plain-language walkthrough of the card payment lifecycle (authorization, capture, and settlement) and the parties involved in every card transaction. - [What NPP, PayID, and PayTo Are](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/npp-payid-payto.md): Learn how Australia’s New Payments Platform, PayID, and PayTo work together to enable real-time, secure, and flexible bank payments. - [PayID for C2B Payments](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/payid-c2b.md): How PayID enables real-time consumer-to-business payments, how it compares with BSB transfers and BPAY, and what custom domain PayIDs offer businesses. - [PayID, Bank Transfers, and BPAY](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/payid-bank-transfers-bpay.md): Compare the main ways Australian customers pay a business into a bank account (PayID, standard bank transfers, and BPAY) on speed, experience, and reconciliation. - [PayTo for Recurring Payments](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/payto-recurring.md): How PayTo replaces traditional direct debit with real-time, customer-authorised agreements for subscriptions and recurring billing in Australia. - [PayTo Agreement Specification](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/payto-agreement-spec.md): A field-by-field reference for the PayTo agreement (mandate): what each part means, why it matters, and how it supports automatic reconciliation. - [PayTo vs. Direct Debit](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/payto-vs-direct-debit.md): How PayTo improves on traditional direct debit in Australia: real-time settlement, customer-managed agreements, and greater transparency and control. - [Australian Card Schemes: eftpos, Visa, and Mastercard](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/card-schemes.md): Understand the card schemes Australian customers use (eftpos, Visa, and Mastercard), how dual-network cards and least-cost routing work, and what it means for merchants. - [Bank Transfers in Japan](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/bank-transfers.md): How bank transfers work in Japan through the Zengin System, the country’s long-established network that relays fund transfer data between nearly all its banks. - [Real-time Transfers and the More Time System](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/real-time-transfers.md): How Japan’s More Time System enabled 24/7 real-time bank transfers on top of the Zengin System, and what the planned 2030 overhaul will add. - [Accepting JPY A2A Payins](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/jpy-payins.md): What to know about collecting account-to-account payments in Japanese yen: how they clear through the Zengin System and how to reconcile them. - [Account Transfer and Direct Debit in Japan](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/account-transfer.md): How recurring payments work in Japan through kōza furikae (account transfer / direct debit), the standard way households pay regular bills. - [Japanese Card Schemes: JCB and Beyond](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/jp/card-schemes.md): Understand the card schemes Japanese customers use (the domestic JCB network alongside Visa, Mastercard, and American Express) and why accepting JCB matters. - [FedNow and RTP: US Instant Payments](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/instant-payments.md): How the two US instant payment systems (FedNow from the Federal Reserve and RTP from The Clearing House) enable real-time, 24/7 account-to-account payments. - [ACH Credit Transfers and Same-Day ACH](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/ach-credit.md): How the US ACH network moves money in batches, the difference between standard and same-day ACH, and how ACH compares with instant rails like FedNow and RTP. - [ACH Debit and Recurring Billing](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/ach-debit.md): How ACH debit pull payments power recurring billing in the US (subscriptions, memberships, and utilities) and how they compare with instant-rail alternatives. - [US Card Schemes: Visa, Mastercard, and Amex](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/us/card-schemes.md): Understand the card schemes US customers use (Visa, Mastercard, American Express, and Discover) and how debit and credit routing works in the United States. - [India: UPI](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/india-upi.md): A comparative reference to India’s Unified Payments Interface (UPI), the world’s most-used real-time payment system, and how it relates to the concepts in this section. - [Southeast Asia: PromptPay, FAST, and DuitNow](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/southeast-asia.md): A comparative reference to real-time payment systems across Southeast Asia (Thailand’s PromptPay, Singapore’s FAST, and Malaysia’s DuitNow) and how they connect. - [Handling AUD, JPY, and USD Payins and Payouts](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/multi-currency-payins-payouts.md): How to collect and send payments across Australian dollars, Japanese yen, and US dollars, and how multi-currency Treasury Accounts keep each currency separate. - [FX and Settlement Across AU, JPN, and USA](https://docs.rc.cleverhub.co/platform-overview/payment-concepts/fx-and-settlement.md): How currency conversion (FX) and settlement work when operating across Australia, Japan, and the United States: converting between AUD, JPY, and USD and accessing funds. - [Clever Connect Overview](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/overview.md): A flexible way to manage the money flowing through your Hello Clever account, with balance models, Payments Accounts, and Treasury Accounts that fit how your business is organised. - [Clever Connect vs. a Standard Account](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/clever-connect-vs-standard.md): How a Clever Connect account differs from a standard Hello Clever merchant account: who collects the money, how balances are separated, who controls onboarding, and who sets the fees. - [Balance Management Guide](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/balance-management-guide.md): An introduction to how Clever Connect manages your funds: the key terms, how your balance model is set during onboarding, and what it means for existing merchants. - [Balance Models: Aggregated vs. Dedicated](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/balance-models.md): The two ways Clever Connect tracks your funds: Aggregated Balance keeps one shared balance, Dedicated Balance keeps a separate balance per account. Learn how each works and which to choose. - [Payments Accounts](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/payments-accounts.md): Payments Accounts are sub-accounts inside your merchant account used to accept and manage payments, one per store, brand, or payment flow, all under one merchant. - [Treasury Accounts](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/treasury-accounts.md): Treasury Accounts are currency-specific accounts for holding, receiving, and moving funds, available in AUD. Learn how they work and how to deposit into one. - [Viewing Your Balances](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/viewing-balances.md): How your balances appear on the Clever Connect dashboard: one balance per currency under Aggregated Balance, or a separate balance per account under Dedicated Balance. - [Moving Money: Settlements, Withdrawals, and Transfers](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/moving-money.md): How money moves in Clever Connect: the difference between a Settlement and an Account Transfer, and how Settlements and Withdrawals behave under each balance model. - [Transfer Flow](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/transfer-flow.md): How to move funds out of a Treasury Account: the enter-amount screen, the confirmation screen, and how to simulate a transfer’s outcome with the API. - [Clever Connect FAQ](https://docs.rc.cleverhub.co/platform-overview/clever-concepts/faq.md): Answers to common questions about Clever Connect: balance models, existing merchants, settlements, Treasury Accounts, and testing deposits and transfers. - [Merchant Portal Overview](https://docs.rc.cleverhub.co/portal/overview.md): Navigate the Hello Clever Merchant Portal dashboard to manage payments, balances, accounts, cashback campaigns, and your team from one place. - [Managing Payins in the Merchant Portal](https://docs.rc.cleverhub.co/portal/payins.md): View incoming payment history, search and filter transactions, customize columns, export data, generate manual payment links, and resolve disputes. - [Managing Payouts in the Merchant Portal](https://docs.rc.cleverhub.co/portal/payouts.md): Track outgoing payments, filter by status or payment method, export payout reports, and initiate manual payouts to recipients from the portal. - [Managing Balances and Accounts](https://docs.rc.cleverhub.co/portal/balances.md): Understand your available, incoming, and outgoing balances per currency and account, work with balance models, manage Payments and Treasury Accounts, and move funds through settlements, top-ups, deposits, and transfers. - [Creating and Managing Cashback Campaigns](https://docs.rc.cleverhub.co/portal/cashback-campaigns.md): Set up instant cashback campaigns for in-store or online purchases, configure tiered rules and budgets, schedule timing, and publish to the app. - [Merchant Account Settings and Team Management](https://docs.rc.cleverhub.co/portal/account-settings.md): Manage your Hello Clever account security with 2FA, invite and manage team members with role-based access, and maintain your API keys and profile settings. - [Clever AI Actionable Insights](https://docs.rc.cleverhub.co/clever-ai/actionable-insights.md): Continuous, AI-generated recommendations from your transaction and customer data, each with a suggested next step you can act on immediately. - [Clever AI Forecaster](https://docs.rc.cleverhub.co/clever-ai/forecaster.md): Simulate cashback campaign outcomes over 30, 60, or 90 days before launching: compare scenarios, estimate uplift, and commit budget with confidence. - [Regular Checkout](https://docs.rc.cleverhub.co/platform-overview/customer-guides/regular-checkout.md): Step-by-step guide for completing a regular checkout with Hello Clever. - [Express Checkout](https://docs.rc.cleverhub.co/platform-overview/customer-guides/express-checkout.md): Step-by-step guide to using Express Checkout with Hello Clever on WooCommerce stores. - [Guest Checkout](https://docs.rc.cleverhub.co/platform-overview/customer-guides/guest-checkout.md): Guide to completing a guest checkout with Hello Clever. - [We’re SOC 2 Compliant](https://docs.rc.cleverhub.co/platform-overview/compliance/soc-2-compliant.md): How Hello Clever’s SOC 2 compliance keeps merchant data secure and builds trust, and what the five Trust Service Principles mean for you. - [How We Handle Data](https://docs.rc.cleverhub.co/platform-overview/compliance/how-handle-data.md): How Hello Clever secures business, transaction, and consumer data, respects data sovereignty laws, and uses data responsibly for AI and ML. - [Know Your Customer (KYC)](https://docs.rc.cleverhub.co/platform-overview/compliance/kyc.md): How Hello Clever’s KYC process verifies consumer identities, why beneficiary bank accounts must be your own, and how our KYC providers keep your information safe. - [Anti-Money Laundering (AML) & Counter-Terrorism Financing (CTF)](https://docs.rc.cleverhub.co/platform-overview/compliance/aml-ctf.md): How Hello Clever detects and prevents money laundering and terrorism financing through real-time monitoring, our Flagright partnership, and regulatory reporting. - [Choose the Right Hello Clever Integration](https://docs.rc.cleverhub.co/integrations/choosing-integration.md): Match your platform or business model to the correct Hello Clever integration guide or API so you can get up and running without guesswork. - [Obtain Your Hello Clever Integration Keys Securely](https://docs.rc.cleverhub.co/integration-keys.md): Generate your app-id and secret-key by creating a Payments Account in the Hello Clever Merchant Dashboard to authenticate API calls and plugin connections. - [Add Hello Clever to Shopify](https://docs.rc.cleverhub.co/integrations/shopify.md): Install Hello Clever on your Shopify store and configure express checkout, payment logos, footer branding, and product cashback taglines step by step. - [Add Hello Clever to WooCommerce](https://docs.rc.cleverhub.co/integrations/woocommerce.md): Install and configure the Hello Clever Gateway plugin for WooCommerce, then enable express checkout or one-click checkout on your WordPress store. - [Add Hello Clever to Magento](https://docs.rc.cleverhub.co/integrations/magento.md): Download, install, and configure the Hello Clever payment gateway extension for Magento 2 stores to accept PayID, PayTo, and cashback-enabled payments. - [Add Hello Clever to OpenCart](https://docs.rc.cleverhub.co/integrations/opencart.md): Download and install the Hello Clever payment gateway plugin for OpenCart, configure your API credentials, and verify the checkout integration is live. - [Add Hello Clever to Tyro POS](https://docs.rc.cleverhub.co/integrations/tyro.md): Link your Tyro POS terminals to Hello Clever to run instant cashback campaigns in your physical store and manage them from the Merchant Dashboard. - [Add Hello Clever to Shopline](https://docs.rc.cleverhub.co/integrations/shopline.md): Connect Hello Clever to Shopline to accept PayID payments, display payment logos at checkout, and process refunds directly from your Shopline Admin panel. - [Add Hello Clever to Xero](https://docs.rc.cleverhub.co/integrations/xero.md): Connect Hello Clever to your Xero account to collect invoice payments via PayID, automate fee reconciliation, and sync settlement transfers in real time. - [Build Recurring Billing with PayTo Agreements](https://docs.rc.cleverhub.co/developer-reference/api-use-cases/build-recurring-billing-with-payto-agreements.md): Set up bank-authorised PayTo mandates and draw recurring payments for subscriptions, instalments, and usage-based billing. - [Accept Instant Payments with AUD PayID](https://docs.rc.cleverhub.co/developer-reference/api-use-cases/accept-instant-payments-with-aud-payid.md): Collect real-time bank payments over the NPP using one-time and static PayIDs, with instant webhooks on settlement. - [Handle Multi-Currency Payins and Payouts](https://docs.rc.cleverhub.co/developer-reference/api-use-cases/handle-multi-currency-payins-and-payouts.md): Collect and disburse funds across many currencies and local rails (bank transfers, mobile money, e-wallets, and QR) with per-currency Treasury Accounts. - [Drive Loyalty with Cashback Campaigns](https://docs.rc.cleverhub.co/developer-reference/api-use-cases/drive-loyalty-with-cashback-campaigns.md): Configure campaigns, enrol users, deliver real-time cashback on qualifying payments, and manage withdrawals. - [Issue and Manage Card Payments](https://docs.rc.cleverhub.co/developer-reference/api-use-cases/issue-and-manage-cards.md): Accept and manage card payments end to end: create, authorise, capture, void, refund, and tokenise via SDK or server-to-server. - [Shopify Connector](https://docs.rc.cleverhub.co/clever-ai/shopify-connector.md): This guide walks you through the end-to-end setup process: creating the connector app, generating the required credentials in Shopify, entering them in Clever AI, and using the chatbot once your data has synced. - [WooCommerce Connector](https://docs.rc.cleverhub.co/clever-ai/woocommerce-connector.md): This guide walks you through the end-to-end setup process: creating the REST API credentials in WooCommerce, entering them in Clever AI, and using the chatbot once your data has synced. - [Hello Clever API Security Best Practices](https://docs.rc.cleverhub.co/security/api-security.md): Learn how Hello Clever secures its API through authentication, HTTPS encryption, rate limiting, and key management, and how to keep your integration safe. - [Card Payment Security and 3DS2](https://docs.rc.cleverhub.co/security/card-security.md): How Hello Clever protects card transactions through end-to-end encryption, tokenisation, 3DS2 authentication flow, and PCI DSS Level 1 certification. - [Real-time Payment Security at Hello Clever](https://docs.rc.cleverhub.co/security/real-time-payments-security.md): Learn how Hello Clever ensures secure real-time payments, with PayID in Australia as an example of the security benefits of account-to-account transfers. - [Payment Gateway Security](https://docs.rc.cleverhub.co/security/payment-gateway-security.md): Learn about Hello Clever’s security practices, including account security, HTTPS protocol, data privacy, penetration testing, secure server-to-server integration, and additional protections with Cloudflare and Azure Security Centre. - [Fraud Monitoring and Prevention](https://docs.rc.cleverhub.co/security/fraud-monitoring.md): Hello Clever’s fraud detection uses rule-based and ML signals, automated blocking, post-payment screening, and real-time payment security measures. - [Hello Clever API Overview](https://docs.rc.cleverhub.co/api/overview.md): The Hello Clever API suite covers five versioned APIs: AUD payments, multi-currency payin/payout, gateway checkout, card processing, and cashback rewards. - [Authenticate with the Hello Clever API](https://docs.rc.cleverhub.co/api/authentication.md): Learn how to include your app-id and secret-key on every Hello Clever API request, and when the v1 payment gateway link needs an additional access token. - [Webhooks: Real-time Payment Notifications](https://docs.rc.cleverhub.co/api/webhooks.md): Set up Hello Clever webhooks to receive POST notifications on payment status changes. Includes payload reference, error codes, security, and retry behaviour. - [Payment APIs for AUD (v1)](https://docs.rc.cleverhub.co/api/v1/introduction.md): Hello Clever’s v1 API covers PayID, BSB/Account transfers, PayTo agreements, payouts, cashback delivery, and balance management for AUD payments in Australia. - [AUD Balance API Reference](https://docs.rc.cleverhub.co/api/v1/balance.md): Query AUD account balances (available, incoming, outgoing, rolling reserve, and withdrawable) and retrieve balance history via the Hello Clever v1 API. - [Simulate Deposit API Reference](https://docs.rc.cleverhub.co/api/v1/simulate-deposit.md): Simulate an inbound deposit into a Treasury Account in the sandbox, so you can verify that your integration receives and credits incoming funds correctly. - [Get Balance Details](https://docs.rc.cleverhub.co/api/balance/get-balance-details.md): Retrieve detailed information on the various balance types available for transactions in your account. This API provides insights into different balances, which help in tracking funds across distinct states. The following balance types are included: - [Get Balance History](https://docs.rc.cleverhub.co/api/balance/get-balance-history.md): Access a detailed history of balance transactions over a specified date range. This includes all balance changes in your account, such as incoming payments, refunds, top-ups, and other transactions. Use this endpoint to gain a comprehensive view of how balance values fluctuate due to account activit… - [Generate Access Token](https://docs.rc.cleverhub.co/api/payment-gateway/generate-access-token.md): Generate a temporary access token to authenticate and initiate transactions through the Hello Clever payment gateway. This token is obtained using your app-id and secret-key credentials and is valid for 3600 seconds (1 hour). - [Create Payment Gateway Link](https://docs.rc.cleverhub.co/api/payment-gateway/create-payment-gateway-link.md): Creates a payment gateway link for redirecting the customer to complete a payment. Once the payment is made successfully, Hello Clever will notify the status of the payment via the specified `payment_gateway_notification` endpoint. The payment request has various statuses throughout its lifecycle. - [Create One-Time PayID](https://docs.rc.cleverhub.co/api/aud-payid/create-one-time-payid.md): Generate a unique, one-time-use PayID for processing a single payment transaction. This endpoint creates a secure PayID that the customer can use to complete a payment, allowing merchants to receive funds directly. - [Create Static PayID](https://docs.rc.cleverhub.co/api/aud-payid/create-static-payid.md): Creates a Static Open PayID that serves as a unique, reusable identifier linked to a customer’s information. This Static PayID can be used for multiple transactions, offering a persistent payment identifier that simplifies future payments and customer recognition. - [Get PayID Status](https://docs.rc.cleverhub.co/api/aud-payid/get-payid-status.md): Retrieve the current status of a PayID payment request, providing real-time updates to track the state of a payment. This endpoint is essential for monitoring payment progress and handling different outcomes, including refunds. - [Get Static PayID List](https://docs.rc.cleverhub.co/api/aud-payid/get-static-payid-list.md): Retrieve a comprehensive list of all Static Open PayIDs registered under your account. This endpoint allows for efficient management of Static PayIDs by providing options to filter the results based on customer-specific identifiers. You can filter by email, PayID, or customer ID to quickly locate an… - [Refund Payment](https://docs.rc.cleverhub.co/api/aud-payid/refund-payment.md): Initiate a refund request on a completed payment with a `received` status. This endpoint processes a refund using the available balance in your account. If there is insufficient balance, you will either receive a top-up notification or need to wait for additional funds from new payments (Payins) to… - [Cancel a PayID](https://docs.rc.cleverhub.co/api/aud-payid/cancel-a-payid.md): Cancel an active `pending` PayID transaction, which will deregister the PayID and update the transaction status to `expired`. This action is irreversible and will prevent the PayID from being used for further transactions. - [Get Payment Request List](https://docs.rc.cleverhub.co/api/aud-payid/get-payment-request-list.md): Retrieve a list of payment requests within a specified date range. This endpoint allows you to query transactions based on a `from_date` and `to_date`, supporting a maximum period of up to 1 year. For queries beyond this limit, please contact our support team. - [Get Payment Request Statistics](https://docs.rc.cleverhub.co/api/aud-payid/get-payment-request-statistics.md): Retrieve summary statistics for payment requests, including the total gross amount, the number of completed transactions, and the number of pending transactions. This endpoint provides an overview of your payment requests, helping you monitor transaction performance at a glance. - [Create BSB/Account Number Payment](https://docs.rc.cleverhub.co/api/aud-bsbaccount-number/create-bsbaccount-number-payment.md): Initiate a payment request to a BSB and account number by specifying the amount, customer details, and additional attributes. This endpoint supports only Australian Dollar (AUD) payments. Transactions will be rejected if any of the required fields, such as Account Name, BSB Number, Account Number, D… - [Get Payment Request List](https://docs.rc.cleverhub.co/api/aud-bsbaccount-number/get-payment-request-list.md): Retrieve a list of bank payment requests within a specified time period, up to a maximum of 1 year. This endpoint enables you to track and manage transactions by querying records based on a start (`from_date`) and end date (`to_date`). For queries beyond the 1-year limit, please contact our support… - [Get Payment Request Status](https://docs.rc.cleverhub.co/api/aud-bsbaccount-number/get-payment-request-status.md): Retrieve the current status of a bank payment request. This endpoint allows you to check the status of a specific payment, helping you track its progress and outcome. The possible statuses are as follows: - [Create Payment Agreement](https://docs.rc.cleverhub.co/api/aud-payto/create-payment-agreement.md): Create a payment agreement that enables recurring or one-time payments between merchants and payers. This agreement specifies the transaction structure, including payment limits, agreement type, and callback details for status notifications. - [Amend Payment Agreement](https://docs.rc.cleverhub.co/api/aud-payto/amend-payment-agreement.md): Amend an existing payment agreement to modify its parameters, such as the limit amount or agreement details. This endpoint allows the merchant to adjust various settings of the payment agreement, including payment limits and specific agreement terms, providing flexibility to accommodate different pa… - [Change Payment Agreement Status](https://docs.rc.cleverhub.co/api/aud-payto/change-payment-agreement-status.md): Update the status of an existing payment agreement. This endpoint allows merchants to manage the status of payment agreements based on their business requirements. The status options available are: - [Get Payment Agreement Detail](https://docs.rc.cleverhub.co/api/aud-payto/get-payment-agreement-detail.md): Retrieve the details of a specific payment agreement, including its current status. This endpoint provides insight into the lifecycle and status of a payment agreement, which can be one of the following: - [Get Payment Agreements](https://docs.rc.cleverhub.co/api/aud-payto/get-payment-agreements.md): Retrieve a paginated list of payment agreements within a specified time range. This endpoint enables merchants to query and filter payment agreements based on date parameters, allowing for efficient management and monitoring of agreement records over a specified period. - [Create a Payout](https://docs.rc.cleverhub.co/api/aud-payout/create-a-payout.md): Initiate a batch payout to multiple recipients using either PayID or BSB-enabled accounts. This API enables efficient bulk payment processing, allowing merchants to handle payouts to multiple recipients in a single request. - [Get Payout List](https://docs.rc.cleverhub.co/api/aud-payout/get-payout-list.md): Retrieve a list of payout transactions made within a specified time frame. This endpoint allows you to track payouts over a given period, with paging options for large datasets. You can query up to a 1-year period. If additional support for a longer time range is required, please contact our support… - [Create Payout Batch via File](https://docs.rc.cleverhub.co/api/aud-payout/create-payout-batch-via-file.md): This API enables you to create a batch payout to PayID or NPP-enabled BSB accounts by uploading a file containing payout details, facilitating bulk payment processing to multiple recipients efficiently. - [Cancel Scheduled Payout](https://docs.rc.cleverhub.co/api/aud-payout/cancel-scheduled-payout.md): Cancel a scheduled payout payment that is set to run in the future. This endpoint is useful if you need to stop a planned payout that has not yet been processed, allowing you to make adjustments or halt the transaction before it occurs. - [Get Payout Detail](https://docs.rc.cleverhub.co/api/aud-payout/get-payout-detail.md): Retrieve detailed information about a specific payout payment, including its status, total amount, failed transactions, and other relevant details. This endpoint allows you to check the payout payment’s current status and access additional information such as notification details and associated tran… - [Create KYC for Beneficiary](https://docs.rc.cleverhub.co/api/aud-payout/create-kyc-for-beneficiary.md): Submit KYC (Know Your Customer) documentation for a beneficiary before proceeding with a payout. The KYC submission helps verify the beneficiary’s identity. The email provided will be used for approving the payout process in subsequent steps. - [Get Cashback Campaign List](https://docs.rc.cleverhub.co/api/cashback/get-cashback-campaign-list.md): Retrieves a paginated list of current cashback campaigns available on the site. This endpoint allows merchants to view and manage ongoing promotional cashback offers, including filtering by campaign status such as active, scheduled, or inactive. Detailed information about each campaign is provided,… - [Get Campaign Configurations](https://docs.rc.cleverhub.co/api/cashback/get-campaign-configurations.md): Retrieves detailed cashback conditions and configurations for the merchant's specific campaign. This includes maximum payable amounts, time schedules, applicable payment methods, campaign status, and cashback tiers with specific conditions and values. Useful for merchants to understand the parameter… - [Activate User's Cashback Account](https://docs.rc.cleverhub.co/api/cashback/activate-users-cashback-account.md): Activates a user to be eligible for receiving and withdrawing cashback through cashback campaigns. This endpoint validates the existence of the user and registers them for cashback activities. Required fields include `user_id`, `first_name`, and `last_name`. Optional fields like `email` and `phone`… - [Initiate Cashback Delivery](https://docs.rc.cleverhub.co/api/cashback/initiate-cashback-delivery.md): Calculates and delivers cashback to a user participating in a cashback campaign. Funds will be deducted from the merchant's balance to transfer to the user, so it is essential to ensure sufficient balance before initiating the cashback delivery. This endpoint requires details such as the user's ID,… - [Initiate Cashback Withdrawal](https://docs.rc.cleverhub.co/api/cashback/initiate-cashback-withdrawal.md): Allows a customer to withdraw their available cashback balance from their cashback account to their bank account. The customer must have sufficient cashback balance to cover the withdrawal amount. The endpoint supports payouts to bank accounts or PayIDs and requires payout method details. Webhook no… - [Get User List](https://docs.rc.cleverhub.co/api/cashback/get-user-list.md): Retrieves a paginated list of users associated with the site. This endpoint allows merchants to view all users who have activated their cashback accounts, including their personal information and account creation dates. Supports pagination to manage large datasets. - [Multi-Currency Payment API (v2)](https://docs.rc.cleverhub.co/api/v2/introduction.md): Build payin and payout flows across APAC and beyond with Hello Clever’s v2 multi-currency API: one schema, many currencies, full control. - [Multi-Currency Payin API Reference (v2)](https://docs.rc.cleverhub.co/api/v2/payin.md): Create, cancel, refund, and query multi-currency payins across APAC using Hello Clever v2. Supports bank transfer, e-wallet, QR, and mobile money methods. - [Multi-Currency Payout API Reference (v2)](https://docs.rc.cleverhub.co/api/v2/payout.md): Send funds to recipients across multiple currencies with Hello Clever's v2 Payout endpoints: bank transfers, mobile money, QR, and more. - [Balance API Reference (v2)](https://docs.rc.cleverhub.co/api/v2/balance.md): Query multi-currency balance details and retrieve full balance transaction history across all currencies configured on your Hello Clever merchant account. - [Get Balance Details V2](https://docs.rc.cleverhub.co/api/balance/get-balance-details-v2.md): There are 5 balance types: - `available_balance`: The balance available for all transactions. - `incoming_balance`: The balance shows successful payments but the 3rd party device has not yet paid for it (payment card). - `outgoing_balance`: The balance being transferred is waiting to be taken… - [Get Balance History V2](https://docs.rc.cleverhub.co/api/balance/get-balance-history-v2.md): Access a detailed history of balance transactions over a specified date range. This includes all balance changes in your account, such as incoming payments, refunds, top-ups, and other transactions. Use this endpoint to gain a comprehensive view of how balance values fluctuate due to account activit… - [Get Payin Methods](https://docs.rc.cleverhub.co/api/payin-methods/get-payin-methods.md): 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. - [Get Payin’s Required Fields](https://docs.rc.cleverhub.co/api/payin-methods/get-payin’s-required-fields.md): 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. - [Create a Payin](https://docs.rc.cleverhub.co/api/payin/create-a-payin.md): To be able to successfully create a payin request you would need the following APIs in consideration: - Step 1: Call the **Get payin methods** to retrieve the list of supported methods. - Step 2: Call the **Get payin required fields** to get specific required fields for each method. - Step 3: Creat… - [Get Payin Requests in a Period of Time](https://docs.rc.cleverhub.co/api/payin/get-payin-requests-in-a-period-of-time.md): This API allows you to fetch a complete list of payin linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 transactions per page. - [Get PayIn details](https://docs.rc.cleverhub.co/api/payin/get-payin-details.md): This API allows you to fetch the detail of a specific payment link. You can use the UUID to retrieve the detail of payment link. - [Payin Request Simulation](https://docs.rc.cleverhub.co/api/payin/payin-request-simulation.md): This API allows you to simulate a payin request completion. This is useful for testing purposes and works only in sandbox environment. To complete the payment, it must be in a PENDING status. - [Refund Payin](https://docs.rc.cleverhub.co/api/payin/refund-payin.md): This API processes a refund request for a specific payment link. It supports both full and partial refunds. If the refund amount is not provided, the full payment amount will be refunded. - [Cancel Payin](https://docs.rc.cleverhub.co/api/payin/cancel-payin.md): Cancel a `pending` Payin transaction,the transaction status will be updated to `expired`. Before cancel payin, check if the payin method is cancellable (`is_cancellable == true`). - [Authorizing an OTP transaction](https://docs.rc.cleverhub.co/api/mobile-money/authorizing-an-otp-transaction.md): After submitting a request to **Create a PayIn** using the mobile_money PayIn method, if the `stage` field is `authorize_otp`, it means an OTP has been sent to the wallet owner's phone. You should collect the OTP to authorize the Payin. Retrieve the OTP sent to the customer's phone and send a reques… - [Resend OTP](https://docs.rc.cleverhub.co/api/mobile-money/resend-otp.md): This endpoint allows you to resend OTP in a situation where the initial OTP received had expired or was not received at all. - [Authorizing an STK transaction(Sandbox only)](https://docs.rc.cleverhub.co/api/mobile-money/authorizing-an-stk-transactionsandbox-only.md): This endpoint allows you to authorize the transaction in the Sandbox environment. It is meant to simulate a wallet owner entering their wallet PIN at the STK prompt. - [Resend STK (Sim toolkit)](https://docs.rc.cleverhub.co/api/mobile-money/resend-stk-sim-toolkit.md): This endpoint allows you to resend the STK prompt in a situation where the initial STK prompt received had expired or was not received at all. - [Authorising OTP transaction](https://docs.rc.cleverhub.co/api/va-bank-transfer/authorising-otp-transaction.md): After submitting a request to create a PayIn using the `kr_bank_va_kyc_krw` PayIn method, if the stage field is `authorize_otp`, it means an OTP has been generated and it has been sent to the owner's bank account. You need to collect the OTP to authorize the PayIn. Retrieve the OTP sent to the custo… - [Revoke Virtual Account](https://docs.rc.cleverhub.co/api/va-bank-transfer/revoke-virtual-account.md): This endpoint revokes a virtual bank account that was issued after successful OTP verification but before the customer completes the payment transfer. - [Get Payout Methods](https://docs.rc.cleverhub.co/api/payout-methods/get-payout-methods.md): 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. - [Get Payout Required Fields](https://docs.rc.cleverhub.co/api/payout-methods/get-payout-required-fields.md): 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. - [Create a Payout](https://docs.rc.cleverhub.co/api/payout/create-a-payout.md): This API enables outbound payments in mutilple currency using supported payout methods. Steps to create a payout: - Step 1: Call the **Get payout methods** to retrieve the list of supported methods. - Step 2: Call the **Get payout required fields** to get specific required fields for each method… - [Get Payout Requests in a Period of Time](https://docs.rc.cleverhub.co/api/payout/get-payout-requests-in-a-period-of-time.md): You can easily query payout payments in a period of time. Currently we support up to 1 year period. Should you need more, please contact us directly. - [Get Payout Details](https://docs.rc.cleverhub.co/api/payout/get-payout-details.md): 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. - [Payout Simulation](https://docs.rc.cleverhub.co/api/payout/payout-simulation.md): This API works only in sandbox environment and allows you to simulate the completion of a payment. To complete the payout, it must be in a PENDING status. - [Cancel a Scheduled Payout](https://docs.rc.cleverhub.co/api/payout/cancel-a-scheduled-payout.md): You can cancel a payout payment scheduled to run in the future. - [Get Branch Codes](https://docs.rc.cleverhub.co/api/payout/get-branch-codes.md): You can get branch codes for a payout payment. Currently we only support branch codes for payout method `vn_bank_vnd`. Branch code is required when: - Payout amount is greater than 300,000,000 VND - The bank is in the list of banks requiring branch code - [Create Customer](https://docs.rc.cleverhub.co/api/customer/create-customer.md) - [Get Customer Requests in a Period of Time](https://docs.rc.cleverhub.co/api/customer/get-customer-requests-in-a-period-of-time.md): This API allows you to fetch a complete list of customer linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 transactions per page. - [Get Customer Details](https://docs.rc.cleverhub.co/api/customer/get-customer-details.md): This API allows you to fetch the details of a specific customer request. You can use the UUID to retrieve the details of the customer. - [Create Contact](https://docs.rc.cleverhub.co/api/contact/create-contact.md): When processing a `Payin` or `Payout` transaction, if the `require_contact` parameter is `true`, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with… - [Submit KYC](https://docs.rc.cleverhub.co/api/contact/submit-kyc.md): This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact `email`. - [Generate Share Token Using Sumsub API](https://docs.rc.cleverhub.co/api/contact/generate-share-token-using-sumsub-api.md): Contact Hello Clever Support team to get `Sumsub` Client ID. - [Submit KYC With Token](https://docs.rc.cleverhub.co/api/contact/submit-kyc-with-token.md): This API enables merchants to verify a contact’s identity seamlessly using `Sumsub` KYC solution. Instead of requiring contacts to upload identification documents and selfies directly, this API leverages a token-based approach. When a contact completes their KYC process through `Sumsub` interface, a… - [Resend Contact Verification](https://docs.rc.cleverhub.co/api/contact/resend-contact-verification.md): This API allows merchants to trigger a re-sending of the identity verification link to a previously created contact. This is useful when the original verification email or SMS was not received, has expired, or the contact needs to restart the verification flow. - [Update Contact (Deprecated)](https://docs.rc.cleverhub.co/api/contact/update-contact-deprecated.md): This API allows you to update the information of an existing contact in the system. To do so, you need to provide the contact `email` and the updated details of the contact. - [Get Contact Requests in a Period of Time](https://docs.rc.cleverhub.co/api/contact/get-contact-requests-in-a-period-of-time.md): This API allows you to fetch a complete list of contacts linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 records per page. - [Get Contact Details](https://docs.rc.cleverhub.co/api/contact/get-contact-details.md): This API allows you to fetch the details of a specific contact request. You can use the `email` to retrieve the details of the contact. - [Delete Contact (Deprecated)](https://docs.rc.cleverhub.co/api/contact/delete-contact-deprecated.md): This API allows you to delete contact. You can use the `email` to delete. - [Lookup via QR Content](https://docs.rc.cleverhub.co/api/bank-lookup-vnd-only/lookup-via-qr-content.md): Accepts VietQR (EMV Co) QR content. - [Lookup via QR Image](https://docs.rc.cleverhub.co/api/bank-lookup-vnd-only/lookup-via-qr-image.md): Accepts VietQR (EMV Co) QR image. - [Payment Gateway 3 API (v3)](https://docs.rc.cleverhub.co/api/v3/introduction.md): Hello Clever’s v3 gateway lets you accept any supported currency with a single API call that returns a hosted checkout link your customers complete. - [Get PayIn methods](https://docs.rc.cleverhub.co/api/payin/get-payin-methods.md): 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. - [List PayIns](https://docs.rc.cleverhub.co/api/payin/list-payins.md): This API allows you to fetch a payment links list of customer linked to your app-id. This API is paginated. The default is 20 transactions per page. - [Create PayIn](https://docs.rc.cleverhub.co/api/payin/create-payin.md): To be able to successfully create a payment link you would need the following APIs in consideration: - **Step 1**: Call the **Get PayIn Methods** API to retrieve available payment methods. - **Step 2**: Call the **Create PayIn** with the selected method and sender details. - **Step 3**: Redire… - [Card Payment API Overview](https://docs.rc.cleverhub.co/api/card/overview.md): Hello Clever’s Card API supports authorisation, capture, refund, void, and tokenisation for AUD and USD card payments in SDK or server-to-server mode. - [Create Payment via Card Information (S2S)](https://docs.rc.cleverhub.co/api/cards/create-payment-via-card-information-s2s.md): This endpoint allows you to create a card payment intent using raw card information. - [Create Payment via Tokenisation](https://docs.rc.cleverhub.co/api/cards/create-payment-via-tokenisation.md): This endpoint allows you to create a card payment intent using a previously tokenised or newly provided card. - [Capture Payment](https://docs.rc.cleverhub.co/api/cards/capture-payment.md): This endpoint captures a previously authorised card payment created via the JavaScript SDK or API. - [Void Payment](https://docs.rc.cleverhub.co/api/cards/void-payment.md): This endpoint voids a previously authorised card payment before it is captured. - [Refund Payment](https://docs.rc.cleverhub.co/api/cards/refund-payment.md): This endpoint refunds a captured card payment. You can refund either the full amount or a partial amount. - [Delete Token](https://docs.rc.cleverhub.co/api/cards/delete-token.md): This endpoint deletes or deactivates a previously created `token_id`. - [List Payment](https://docs.rc.cleverhub.co/api/cards/list-payment.md): This API allows you to fetch a complete list of card payment transactions linked to your app-id. You can filter the results using optional query parameters such as date range and status. The response is paginated with a default of 20 transactions per page. - [Detail Payment](https://docs.rc.cleverhub.co/api/cards/detail-payment.md): This API returns the full details of a specific card payment transaction, including card information, amount, currency, status, and webhook configuration. - [Cashback API Overview](https://docs.rc.cleverhub.co/api/cashback/overview.md): Hello Clever’s Cashback API lets you embed instant cashback into your platform: manage campaigns, activate accounts, and trigger cashback delivery via API. ## OpenAPI Specs - [v2-reference](https://docs.rc.cleverhub.co/api/openapi/v2-reference.yaml) - [v1-reference](https://docs.rc.cleverhub.co/api/openapi/v1-reference.yaml) - [v3-reference](https://docs.rc.cleverhub.co/api/openapi/v3-reference.yaml) - [cashback-reference](https://docs.rc.cleverhub.co/api/openapi/cashback-reference.yaml) - [card-reference](https://docs.rc.cleverhub.co/api/openapi/card-reference.yaml)