Account Structure
Entity hierarchy
Organisation└── Biller (Account) ├── Customers │ ├── Payment Instruments │ └── Payment Plans └── Payment IntentsAn Organisation is the top-level entity — it groups one or more billers and manages user access.
A Biller (also called an Account) is the entity that accepts payments. Each biller has its own API keys, customers, and payment configuration. Most API integrations operate at the biller level.
Biller fields
| Field | Description |
|---|---|
name | Display name for the biller |
email | Contact email |
currency | ISO 4217 currency code (e.g. AUD, NZD, USD) |
country | ISO 3166-1 alpha-2 country code (e.g. AU, NZ) |
timezone | IANA timezone string (e.g. Australia/Sydney) |
mode | sandbox or live |
Sandbox and live modes
Each biller has a mode: sandbox or live. A sandbox biller and a live biller are linked as a pair under the same organisation.
- API keys for a sandbox biller only work in sandbox mode
- Data (customers, payment intents) is not shared between modes
- Switch between them using the mode toggle in the dashboard
Account states
| State | Description |
|---|---|
pre_activation | Account created, not yet activated for live payments |
active | Account is operational |
suspended | Temporarily paused — payments are rejected |
deactivated | Permanently closed — no new payments accepted |
Compliance states
Live accounts require a compliance review before processing real payments:
| State | Description |
|---|---|
not_required | Sandbox mode — no review needed |
pending | Review not yet submitted |
in_review | Review submitted, awaiting decision |
approved | Account cleared for live payments |
rejected | Review failed — contact support |