# Hello Clever: English API Reference ## API Reference ### Basics - [Hello Clever API Overview](https://docs.helloclever.co/api/overview.md): The Hello Clever API suite covers five APIs: AUD payments, multi-currency payin/payout, card processing, cashback rewards, and settlement reporting. - [Authenticate with the Hello Clever API](https://docs.helloclever.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.helloclever.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 #### v1 (AUD) - [Payment APIs for AUD](https://docs.helloclever.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.helloclever.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.helloclever.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. ##### Balance - [Get Balance Details](https://docs.helloclever.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.helloclever.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… ##### Payment Gateway - [Generate Access Token](https://docs.helloclever.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.helloclever.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. ##### AUD PayID - [Create One-Time PayID](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.co/api/aud-payid/refund-payment.md): Initiate a refund request on a completed payment with a `received` status. A payment request can be refunded multiple times; each refund is recorded separately in `refund_records` instead of overwriting the previous one. This endpoint processes a refund using the available balance in your account. I… - [Cancel a PayID](https://docs.helloclever.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.helloclever.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.helloclever.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. ##### AUD BSB/Account Number - [Create BSB/Account Number Payment](https://docs.helloclever.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.helloclever.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.helloclever.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: ##### AUD PayTo - [Create Payment Agreement](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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. ##### AUD Payout - [Create a Payout](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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. ##### Cashback - [Get Cashback Campaign List](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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. #### v2 (Multi-Currency) - [Multi-Currency Payment API](https://docs.helloclever.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](https://docs.helloclever.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](https://docs.helloclever.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](https://docs.helloclever.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. ##### Balance - [Get Balance Details V2](https://docs.helloclever.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.helloclever.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… ##### Payin Methods - [Get Payin Methods](https://docs.helloclever.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.helloclever.co/api/payin-methods/get-payins-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. ##### Payin - [Create a Payin](https://docs.helloclever.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.helloclever.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.helloclever.co/api/payin/get-payin-details.md): This API allows you to fetch the details of a specific payin request. You can use the UUID to retrieve the details of a specific payment request. - [Payin Request Simulation](https://docs.helloclever.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.helloclever.co/api/payin/refund-payin.md): Initiate a refund request on a completed payin (with `received` status). Before initiating the refund, check if the transaction is refundable (`is_refundable == true`). ___ - [Cancel Payin](https://docs.helloclever.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`). ##### Mobile Money - [Authorizing an OTP transaction](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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. ##### VA Bank Transfer - [Authorising OTP transaction](https://docs.helloclever.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.helloclever.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. ##### Payout Methods - [Get Payout Methods](https://docs.helloclever.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.helloclever.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. ##### Payout - [Create a Payout](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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 ##### Customer - [Create Customer](https://docs.helloclever.co/api/customer/create-customer.md) - [Get Customer Requests in a Period of Time](https://docs.helloclever.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.helloclever.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. ##### Contact - [Create Contact](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.co/api/contact/delete-contact-deprecated.md): This API allows you to delete contact. You can use the `email` to delete. ##### Bank Lookup (VND only) - [Lookup via QR Content](https://docs.helloclever.co/api/bank-lookup-vnd-only/lookup-via-qr-content.md): Accepts VietQR (EMV Co) QR content. - [Lookup via QR Image](https://docs.helloclever.co/api/bank-lookup-vnd-only/lookup-via-qr-image.md): Accepts VietQR (EMV Co) QR image. #### Payment Gateway 3 - [Payment Gateway 3 API](https://docs.helloclever.co/api/v3/introduction.md): Payment Gateway 3 lets you accept any supported currency with a single API call that returns a hosted checkout link your customers complete. ##### PayIn - [Get PayIn methods](https://docs.helloclever.co/api/gateway3/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.helloclever.co/api/gateway3/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.helloclever.co/api/gateway3/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… - [Get PayIn details](https://docs.helloclever.co/api/gateway3/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. - [Refund Payin](https://docs.helloclever.co/api/gateway3/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. ### Card API - [Card Payment API Overview](https://docs.helloclever.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. #### Cards - [Create Payment via Card Information (S2S)](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.co/api/cards/void-payment.md): This endpoint voids a previously authorised card payment before it is captured. - [Refund Payment](https://docs.helloclever.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.helloclever.co/api/cards/delete-token.md): This endpoint deletes or deactivates a previously created `token_id`. - [List Payment](https://docs.helloclever.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.helloclever.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 - [Cashback API Overview](https://docs.helloclever.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. #### Cashback - [Get Cashback Campaign List](https://docs.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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.helloclever.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. ### Reporting API - [Reporting API Overview](https://docs.helloclever.co/api/reporting/overview.md): The Hello Clever Reporting API lists the settlement reports generated for your account and links to each CSV, so you can reconcile payouts on your own schedule instead of waiting for the report email. - [Settlement Reporting](https://docs.helloclever.co/api/reporting/settlement.md): How Hello Clever settlement reports are generated, what each column in the file contains, and how to reconcile a report against your own ledger. #### Reporting - [Get Settlement Reports](https://docs.helloclever.co/api/reporting/get-settlement-reports.md): Lists the settlement reports generated for your account within a date range. One report covers one reporting period, for one currency, at one frequency — so a merchant with daily and monthly reports enabled receives both, and the same settlements appear in each. ## OpenAPI Specs - [v1-reference](/api/openapi/v1-reference.yaml) - [cashback-reference](/api/openapi/cashback-reference.yaml) - [v2-reference](/api/openapi/v2-reference.yaml) - [v3-reference](/api/openapi/v3-reference.yaml) - [card-reference](/api/openapi/card-reference.yaml) - [reporting-reference](/api/openapi/reporting-reference.yaml)