Create a SubAccount

Provision a sub account

Body Params
string
required

Account name suffix for this sub account

int32
required

How much in kobo is the monthly budget for this account

int32
required

How long in minutes should outgoing payments be held before they're disbursed. This specifies the "Hold-Off timer" you see on the dashboard (min: 0)

string
enum

This allows you create other types of accounts, e.g. a virtual account which holds no value directly

Allowed:
signatories
array of strings

Optional - Signatories to account

signatories
string

This can be used as a tracking reference used to tag the account. Since the actual account creation happens later, this helps you confirm success or failure from the received webhook notifications

boolean
Defaults to false

When this is enabled, the short name configured on the business is used, instead of the full registered business name

Responses

Language
Credentials
Header
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json