Create Sub Account (Individual)

post

https://api.sandbox.safehavenmfb.com/accounts/v2/subaccount

Creates a sub-account: a reserved (static) account number that does not expire. For accounts that expire, use Create Virtual Account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Verify the customer first with Initiate Verification (and Validate Verification for BVN and NIN). Then send the verification's _id as identityId, plus identityType and identityNumber.

identityId is required for BVN, NIN and vID.
debitAccountNumber is required when identityType is BVNUSSD or vNIN.
If callbackUrl is not set, payment notifications go to the webhook URL on your dashboard.

Body Params

phoneNumber

string

required

Defaults to +2348000000000

This is the phone number of the account holder. It should begin with the country code.

emailAddress

string

required

Defaults to [email protected]

This is the email address.

externalReference

string

required

This is an external reference to be attached to the account object.

identityType

string

enum

required

Identification method the account holder, should be either NIN, vNIN, BVN, BVNUSSD, or vID (if you are using Safe Haven Verification Service). Example: BVN.

Allowed:

identityNumber

string

It is required when using BVN, NIN, and BVNUSSD. Not required if you are using vID

identityId

string

The _id from the Safe Haven Verification Endpoint. It is required when vID, BVN, or NIN

otp

string

The OTP sent to the customer's phone number when you initiate verification using Safe Haven verification endpoint. This works for BVN and NIN or the OTP sent to customer's phone number when using BVNUSSD

callbackUrl

string

If not provided, the webhook URL on your Dashboard will be used.

companyName

string

The company name.

debitAccountNumber

string

Required when identityType is BVNUSSD or vNIN.

autoSweep

boolean

Defaults to false

This should be set when creating a virtual account. It determines if auto sweep should be enabled or disabled.

autoSweepDetails

object

This contains the auto sweep details to be filled if creating a virtual account.

Headers

ClientID

string

required

Your ibs_client_id, returned by Exchange Client Credentials.

Responses

200200

400400