Telco Details

This resource is to get telco account information such as the name of the telco provider, main account balance, currency, connected phone number etc via the telco account id.

API Reference

API Object

{
  "meta": {
    "data_status": "AVAILABLE",
    "auth_method": "mobile_banking"
  },
  "account": {
    "_id": "62f15763982abb0d25e1fefd",
    "institution": {
      "name": "Mtn",
      "type": "PERSONAL_BANKING"
    },
    "name": "Main Balance",
    "accountNumber": "+2347012345678",
    "type": "CURRENCY",
    "balance": 7659,
    "currency": "NGN",
    "bvn": null
  }
}

Telco Verification Fields

Field

Description

Type

meta

A meta object containing the current data status and the auth method

object

meta.data_status

The status of the returned connected data, if it is AVAILABLE, PROCESSING, FAILED

string

meta.auth_method

This refers to the authentication method used by user. It returns either, mobile_banking or internet_banking

string

account

An object with all account data

object

account._id

The unique identifier for a user which has new or updated transaction data

string

account.institution

All data related to the telco provider institution of the connected user

object

account.institution.name

The institution name of the connected telco account

string

account.institution.type

The type of banking method for this connected telco account.

string

account.name

The account name of the connected user

string

account.accountNumber

The account/phone number of the connected user

string

account.type

The account type of the connected user

string

account.balance

The current account balance of the connected user

integer

account.currency

The curency of the connected user (NGN)

string

account.bvn

The BVN of the connected user if found

string


Did this page help you?