> ## Documentation Index
> Fetch the complete documentation index at: https://docs.helloclever.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Hello Clever API Overview

> The Hello Clever API suite covers five APIs: AUD payments, multi-currency payin/payout, card processing, cashback rewards, and settlement reporting.

The Hello Clever API suite gives you everything you need to build payment experiences on top of Hello Clever’s fintech platform. This page introduces each API version, describes what it is designed for, and helps you choose the right one for your integration.

## API versions at a glance

<CardGroup cols={2}>
  <Card title="API v1: AUD Payment Gateway" icon="dollar-sign" href="/api/v1/introduction">
    The original Hello Clever payment gateway for Australian Dollar transactions. Supports PayID, PayTo, BSB/account number transfers, and AUD payouts. Also includes a cashback campaign integration. Use this API if you are operating exclusively in AUD and need PayID or PayTo support.
  </Card>

  <Card title="API v2: Multi-Currency Payments" icon="globe" href="/api/v2/introduction">
    A full-featured payin and payout API that supports multiple currencies. Includes mobile money, virtual account bank transfers, customer and contact management, and bank lookup for VND. Use this API when you need to accept or send payments in currencies beyond AUD.
  </Card>

  <Card title="Card API" icon="credit-card" href="/api/card/overview">
    Accepts card payments via a JavaScript SDK (client-side, AUD and USD) or a Server-to-Server (S2S) integration (server-side, AUD only). Supports card tokenisation for repeat payments, 3DS authentication, regular and unscheduled payment types, and refunds.
  </Card>

  <Card title="Cashback API" icon="tag" href="/api/cashback/overview">
    Manage cashback campaigns and rewards for your customers. Retrieve campaign lists and perform cashback operations. Use this API to power loyalty and rewards programs on top of your payment integrations.
  </Card>

  <Card title="Reporting API" icon="file-lines" href="/api/reporting/overview">
    Lists the settlement reports generated for your account, each with the period's settlement totals and a link straight to the CSV. Use this API to reconcile Hello Clever settlements against your own ledger or accounting system, in place of the settlement report email.
  </Card>
</CardGroup>

## When to use each version

| Requirement | Recommended API |
| - | - |
| AUD-only payments with PayID | v1 |
| AUD-only payments with PayTo agreements | v1 |
| AUD-only BSB/account number transfers | v1 |
| Multi-currency payin and payout | v2 |
| Mobile money or virtual account transfers | v2 |
| Card payments with JavaScript SDK (AUD, USD) | Card API (SDK integration) |
| Card payments server-side without SDK (AUD only) | Card API (S2S integration) |
| Recurring card payments via saved tokens | Card API |
| Cashback campaigns and rewards | Cashback API |
| Reconciling settlements against your ledger | Reporting API |

## Authentication

Every request to the Hello Clever API requires authentication using your `app-id` and `secret-key`. See the [Authentication](/api/authentication) page for step-by-step instructions on obtaining credentials and passing them in your requests.

## Webhooks

Hello Clever uses webhooks to notify your server when payment statuses change. See the [Webhooks](/api/webhooks) page for the full payload reference, status list, security setup, and retry behaviour.


## Related topics

- [Hello Clever Platform Overview](/platform-overview/overview.md)
- [Authenticate with the Hello Clever API](/api/authentication.md)
- [Hello Clever API Security Best Practices](/security/api-security.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.