Skip to main content

Account Information

With this account information endpoint, all account details with the financial institution are returned via the account id passed to the URL

API Object​

Response
{
"_id": "6296093163a9f8abf120d154",
"institution": {
"name": "access",
"bankCode": "",
"type": "PREMIER SAVINGS"
},
"name": "John Doe",
"accountNumber": "0000000000",
"type": "PREMIER SAVINGS",
"balance": 2210,
"bvn": "2241"
}

Account Fields​

FieldDescriptionType
metaAn event object containing the account data and the current data status.object
meta._idThe unique identifier for the member which has new or updated transaction datastring
meta.institutionAll data related to the financial institution of the connected userobject
meta.institution.nameThe institution name of the connected accountstring
meta.institution.bankCodeThe bank code of the institution name connected to this accountstring
meta.institution.typeThe type of banking method for this connected user. E.g PREMIER_SAVINGS, PERSONAL_BANKING, BUSINESS_BANKING etcstring
meta.nameThe account name of the connected userstring
meta.accountNumberThe account number of the connected userstring
meta.typeThe account type of the connected user E.g SAVINGS ACCOUNT, CURRENT ACCOUNTstring
meta.balanceThe current account balance of the connected userstring
meta.bvnThe BVN of the connected userstring