Permanent Account
List permanent virtual accounts
Changed onReturn a paginated list of permanent virtual accounts for the authenticated business. Use query parameters to filter the collection; never place query strings in the OpenAPI path key.
get/profile/virtual-accounts
Request
- Base URLhttps://sandboxapi.fincra.com
- AuthAPI key in header api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
perPageinteger
status'pending' | 'approved' | 'declined' | 'expired' | 'closed' | 'reviewed'
currency'NGN' | 'GHS' | 'KES' | 'TZS' | 'RWF' | 'UGX' | 'XAF' | 'USD' | 'EUR' | 'GBP' | 'CAD'
Three-letter ISO 4217 currency code for the virtual account.
accountType'individual' | 'corporate'
entityType'main_account' | 'sub_account'
requestedDatestring date
issuedDatestring date
businessNamestring
virtualAccountTypestring
accountNumberstring
merchantReferencestring
Response
Permanent virtual accounts returned successfully.
Example response
{
"message": "Merchant virtual accounts fetched successfully",
"data": {
"results": [
{
"_id": "65f1c9ef838af8cda0211d9d",
"accountInformation": {
"accountNumber": "0123456789",
"accountName": "Ada Okafor",
"bankName": "Example Bank",
"bankCode": "000"
}
}
]
}
}Changes
- info
endpoint added
- info