Create a sub account

Create a sub account for your customers

POST /v1/accounts

Request body

accountRef
string
required

Account reference (a reference on your system that uniquely identifies the account (user) within your own ecosystem)

phoneNumber
string
required

Phone number (you can also use the phone number of the main account)

email
string
required

Email address (you can also use the email address of the main account)

bvn
string
required

Bank Verification Number (BVN)

pin
string
required

Personal Identification Number (PIN)

accountName
string
required

Account holder’s name

currency
string

Currency code

callbackUrl
string

Callback url (if passed, will attach an event to this account such that for every successful payment, a notification is sent to this url)

Response body

code
string
required

Response code

description
string
required

Response description

data
object
createdAt
string
required

Creation timestamp.

accountId
string
required

Account ID.

accountHolderId
string
required

Account holder ID (this is the ID of the parent account)

accountRef
string
required

Account reference.

phoneNumber
string
required

Phone number.

email
string
required

Email address.

bvn
string
required

Bank Verification Number (BVN).

status
enum<string>
required

Account status.

accountName
string
required

Account holder’s name.

currency
string
required

Currency code.

callbackUrl
string

Callback url.