Create Virtual Account
This endpoint provides a unique virtual customer account for processing transactions for existing customers.
POST /api/account/v1/createvirtualaccount
Headers
Content-Type*
application/json
Authorization*
Bearer <token>
Request-Reference
{unique-reference}
Body
accountName
string (100)
Name associated with the account
lastName
string (100)
Customer's last name
firstName
string (100)
Customer's first name
otherNames
string (100)
Customer's other names
phoneNumber
string
Customer's phone number
email
string
Customer's email address
ignorePrefix
boolean
This flag indicates whether an account should be prefixed by a custom alias configured by the financial institution.
Set true for active and false for inactive. The default value is active.
productCode
string (3)
The customer's savings account product code
bvn
string (11)
Bank Verification Number (BVN)
nin
string (11)
National Identification Number (NIN)
maritalStatus
string (20)
The customer's marital status. The enumerations are:
1 = Married,
2 = Single,
3 = Divorced,
4 = Widow,
5 = Widower
religion
string(20)
The customer's religion. The enumerations are:
1 = Christianity,
2 = Islamic,
3 = Others
hometown
string (100)
Customer's hometown
dateOfBirth
date
The customer's Date of birth. The format should be YYYY-MM-DD (e.g., 2025-30-12)
nationality
string (50)
Customer's nationality
state
string (50)
Customer's state of residence
lga
string (50)
Local Government Area (LGA)
identificationType
string
Type of identification (e.g., driver's license, passport) The enumerations are:
1 = National ID (Default),
2 = Drivers License,
3 = Voters Card,
4 = International Passport
identificationNumber
integer
Identification number for the chosen identification type. The product settings will apply if not supplied.
pep
boolean
Politically Exposed Person (PEP) status. Set true for yes and false for no
tin
string (50)
Tax Identification Number (TIN)
employeeID
string (50)
Employee ID if the account is related to employment
address
string (250)
Customer's residential address
documentIdentifier
string (120)
This is an identifier that will link all documents associated with the user. It can be a Guid value or any valid string with no special characters. Guid is recommended
isBusinessAccount
boolean
Set true if the account is for business purposes and false if it's not
Response
Last updated