Create Collective Account RESTful API
API Details
To work with Ledger Accounts, you must first create a Collective Account of type LEDGER
. This account acts as a required parent for all Ledger Accounts.
Note that:
- Ledger Accounts are child accounts grouped under a Ledger Collective Account, enabling organised and scalable account management.
- When creating a Ledger Account you must include the
collectiveAccountId
of a parentLEDGER
Collective Account in the request path. - Attempting to use a non-
LEDGER
type (e.g.,CUSTOMER
orOFFICE
) will result in an error. - A
LEDGER
Collective Account provides a summary of its child accounts:- Aggregated balances
- Combined intraday transactions
- The total balance of a Ledger Collective Account is calculated by summing the balances and intraday activity of all its child Ledger Accounts.
Tip: Always ensure the parent account is of type
LEDGER
before attempting to create a Ledger Account. Swagger Reference:
Posting
Note:
When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.
LIVE https://api.nuapay.com SANDBOX https://sandbox.nuapay.com/
If you haven't done so already and would like to do some testing, please Request Sandbox Access
Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).