Request a permanent virtual account
Changed onRequest a permanent virtual account in a supported currency. The same endpoint handles local-currency and foreign-currency requests; the required KYC and supporting documents vary by currency and account type. Some accounts are approved immediately, while others remain pending until verification and issuance complete.
Request
- Base URLhttps://sandboxapi.fincra.com
- AuthAPI key in header api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"KYCInformation": {
"firstName": "Ada",
"lastName": "Okafor",
"email": "ada.okafor@example.com",
"phone": "+2348012345678",
"bvn": "10000000001",
"address": {
"countryOfResidence": "NG",
"number": "12",
"street": "Marina Road",
"city": "Lagos",
"state": "Lagos",
"zip": "101001"
},
"document": {
"number": "A00000000",
"issuedCountryCode": "NG",
"issuedBy": "Nigeria Immigration Service",
"issuedDate": "2023-01-15",
"expirationDate": "2028-01-14"
},
"birthDate": "1992-06-18",
"nationality": "NG",
"occupation": "Software engineer",
"taxCountry": "NG",
"monthlyTransactionVolume": "5000",
"monthlyTransactionCount": "10",
"accountDesignation": "personal",
"incomeBand": {
"lower": "50000",
"upper": "100000"
},
"annualIncome": "60000"
},
"merchantReference": "va_req_01J9P8J8Y8B4Q6K9R6M5N4P3T2"
}Response
The virtual-account request was accepted.
Example response
{
"data": {
"_id": "65f1c9ef838af8cda0211d9d",
"accountInformation": {
"accountNumber": "0123456789",
"accountName": "Ada Okafor",
"bankName": "Example Bank",
"bankCode": "000"
}
}
}Changes
- breaking
request body became required
- breaking
request property
was restricted to a list of enum values - breaking
request property
was restricted to a list of enum values - breaking
the
request property type changed fromobjectto no type - breaking
the
request property format changed from no format todate-time - breaking
the
request property type changed fromstringtoobject - warning
removed the request property
- warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- info
api operation id
post_profile-virtual-accounts-requestsremoved and replaced withrequest-permanent-virtual-account - info
api tag
Permanent Accountadded - info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added to the
request propertyanyOflist - info
the request property
became optional - info
the request property
became optional - info
the
request property default valueindividualwas removed - info
the
request property default valueCADwas removed - info
added the new
CADenum value to the request property - info
added the new
EURenum value to the request property - info
added the new
GBPenum value to the request property - info
added the new
GHSenum value to the request property - info
added the new
KESenum value to the request property - info
added the new
NGNenum value to the request property - info
added the new
RWFenum value to the request property - info
added the new
TZSenum value to the request property - info
added the new
UGXenum value to the request property - info
added the new
USDenum value to the request property - info
added the new
XAFenum value to the request property - info
added the new
selfenum value to the request property - info
added the new
third_partyenum value to the request property - info
request property
list-of-types was widened by adding typesarrayto media typeapplication/json - info
request property
list-of-types was widened by adding typesarrayto media typeapplication/json - info
request property
list-of-types was widened by adding typesarrayto media typeapplication/json - info
added the media type
application/jsonfor the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- breaking