Account Structure

Entity hierarchy

Organisation
└── Biller (Account)
    ├── Customers
    │   ├── Payment Instruments
    │   └── Payment Plans
    └── Payment Intents

An 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. Read-only until activated: customers, payment plans, payment links and payments can’t be created. Use the sandbox account until then
active	Account is operational
suspended	Temporarily paused — payments are rejected, and scheduled payments are held until the account is reinstated
deactivated	Permanently closed — no new payments accepted, and scheduled payments are never sent

A live account can also stop being currently active after it’s activated. It’s read-only then, as before activation: it refuses the same requests with a 403 live_not_ready error, its dashboard says it isn’t currently active, and its scheduled payments wait until it is. See Switching to live.

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
blocked	Review cannot proceed — contact support
approved	Account cleared for live payments
rejected	Review failed — contact support

These states are internal to the review process; there is no compliance settings screen in the dashboard. While a live account is awaiting activation, its dashboard shows a Continue onboarding banner, and the onboarding application it links to shows the current review status. Once the account is active, the banner is gone.