Reserved Accounts

Reserved accounts create dedicated collection accounts for existing customers. The business must have reserved account access enabled.

Create Reserved Account

Create or fetch a customer first, then use the returned customer_code:

const account = await client.reservedAccounts.create({
  customer_code: 'CUS_...',
  provider: 'netbank'
});

Request fields:

If the customer code is invalid, the API returns HTTP 401 with:

{
  "status": false,
  "message": "Invalid Customer Code"
}

List Reserved Accounts

const accounts = await client.reservedAccounts.retrieveAll({ page: 1, limit: 20 });

Supported query fields: page and limit.

Retrieve One Reserved Account

const account = await client.reservedAccounts.retrieveOne('reserved_account_id');

Retrieve Reserved Account Transactions

const transactions = await client.reservedAccounts.transactions('reserved_account_id', 0);

Get Providers

const providers = await client.reservedAccounts.accountProviders();

Recommended Flow

1. Create or fetch the customer.
2. Create the reserved account using customer_code.
3. Store the returned account ID and account number.
4. Listen for collection webhooks.
5. Verify related transactions before crediting the customer in your own system.