Skip to content

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

FieldDescription
nameDisplay name for the biller
emailContact email
currencyISO 4217 currency code (e.g. AUD, NZD, USD)
countryISO 3166-1 alpha-2 country code (e.g. AU, NZ)
timezoneIANA timezone string (e.g. Australia/Sydney)
modesandbox 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

StateDescription
pre_activationAccount created, not yet activated for live payments
activeAccount is operational
suspendedTemporarily paused — payments are rejected
deactivatedPermanently closed — no new payments accepted

Compliance states

Live accounts require a compliance review before processing real payments:

StateDescription
not_requiredSandbox mode — no review needed
pendingReview not yet submitted
in_reviewReview submitted, awaiting decision
approvedAccount cleared for live payments
rejectedReview failed — contact support