API Reference
  1. Account Management
  2. Sub-account Management

Create sub-account (main account)

post
https://{domain}/api/main-account/sub-accounts

This request will create a new sub-account under the main account. Business should create a new sub-account for each end user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request object for creating a sub-account under a main account.

string | null

ID in your external system for cross-referencing.

string
required
length ≥ 1

First name of the sub-account owner.

string | null

Middle name of the sub-account owner. (Optional)

string
required
length ≥ 1

Last name of the sub-account owner.

date
required

Date of birth of the sub-account owner..

string
enum
required

Gender of the sub-account owner.

Allowed:
string
required
length between 2 and 2
AU

ISO 3166-1 alpha-2 country code.

null

Business details, required when the account type is BUSINESS.

string
enum
required

Type of the sub-account.

Allowed:
string | null

The contact number of the sub-account owner.

string
required
length ≥ 1

The email address of the sub-account owner.

Headers
string
required
length between 0 and 36

A unique client-generated identifier for idempotency. Prevents duplicate requests if the same ID is used more than once.

uuid
required

Main account ID.

string
required

SHA-256 signature of the JSON payload and private key. See API Key Authentication

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 4 months ago

Did this page help you?