The Hello Clever Payment API (v1) provides a comprehensive suite of AUD payment services built for the Australian market. Using these endpoints you can accept payments via PayID, initiate BSB/account number transfers, manage PayTo recurring agreements, run bulk payouts, deliver cashback rewards, and query real-time balance data — all from a single, consistent API.
All endpoints in this section are AUD-only. Support for additional currencies is under development. For queries that span more than one year, contact support@helloclever.co.

​
Base URL

​
Authentication

Every request to the v1 API requires two API key headers issued to your application:
​
app-id
string
required
A unique identifier assigned to your application.
​
secret-key
string
required
A secure token associated with your app-id.
You can also exchange your credentials for a short-lived access token using the Generate Access Token endpoint. Tokens are valid for 3600 seconds (1 hour).

​
API capabilities

PayID

Create one-time and static PayIDs, retrieve payment request lists and statuses, cancel pending PayIDs, and generate hosted payment gateway links.

BSB/Account Number

Initiate direct bank transfers to Australian BSB and account numbers, list bank payments, check payment status, and process refunds.

PayTo agreements

Create, amend, and manage the lifecycle of PayTo payment agreements for recurring or scheduled payments between merchants and payers.

Payouts

Send bulk payouts to multiple recipients via PayID or BSB accounts, upload payout batches via file, retrieve payout details, and cancel scheduled payouts.

Cashback

Query cashback campaigns, activate user cashback accounts, deliver cashback rewards after purchases, and let users withdraw their cashback balance.

Balance

Retrieve a real-time breakdown of your available, incoming, outgoing, rolling-reserve, and withdrawable balances, plus a full balance history.