Developer documentation

Build your first
payment flow,
anywhere.

Step-by-step guides, API references, and a full sandbox: plug into your store platform or build on the API, then go live in any market you serve.

Quickstart

From signup to your first payment

1. Create an account

Sign up and complete KYC to get access to the Merchant Portal.

2. Get your keys

Create a Payments Account, then copy your app ID and secret key.

3. Call the sandbox

Build against the sandbox base URLs, then switch to production.

4. Listen for webhooks

Verify signed events and reconcile them against your orders.
Every endpoint across all five APIs takes the same header pair — see Authentication.
Sandbox request

Prefer no code?

Install a plugin for Shopify, WooCommerce, Magento, OpenCart, Tyro, Shopline, or Xero.

New to these rails?

How PayID, PayTo, NPP, ACH, and card networks actually move money.

Products

Explore by what you’re building

real-time-payin

Real-time PayIn

Collect account-to-account payments that clear in seconds — PayID in Australia, plus real-time rails in Japan, the US, and Asia.
payouts

Payouts

Disburse to bank accounts, virtual accounts, and mobile money wallets, single or in bulk.
cards

Card payments

Accept cards through the JavaScript SDK or server-to-server, with tokenisation, 3DS, and refunds.
instant-cashback

Instant Cashback

Fund and settle rewards the moment a payment clears, driving repeat purchases without a loyalty stack.
multi-currency-fx

Multi-currency & FX

Hold balances, convert between currencies, and settle in the currency your customers actually pay in.
clever-ai

Clever AI

Actionable insights and cash-flow forecasting built on your store and payment data.

API reference

Five APIs, one header pair

Payment Gateway (AUD)

v1 — PayID, PayTo agreements, BSB and account number transfers, and AUD payouts.

Multi-currency Payments

v2 — Payins and payouts beyond AUD, including mobile money, virtual accounts, and bank lookup.

Multi-currency Gateway

v3 — A hosted checkout that handles every currency through one integration, no payment UI to build.

Card API

Client-side SDK or server-to-server card processing, with saved tokens for repeat payments.

Cashback API

Create and manage cashback campaigns, then pay rewards out against them.

Authentication & webhooks

The app-id and secret-key headers, access tokens, signature verification, and retry behaviour.

Guides

Build a complete flow

Accept instant payments with AUD PayID

Build recurring billing with PayTo agreements

Handle multi-currency payins and payouts

Drive loyalty with cashback campaigns

Issue and manage cards

Manage balances and move money

Keep going

Merchant Portal

Reconcile payins and payouts, check balances, and run cashback campaigns without writing code.

Security & compliance

API and card security, fraud monitoring, SOC 2, KYC, and how we handle your data.

Support

Search the merchant knowledge base or reach the team when you need a hand.
First time here? Start with the getting started guide, or see how Hello Clever works for the platform in one page.