Balance (Transaction)

A partner subscribed to the transaction/balance Webhook will be notified when any new data is available after a successful balance fetch. The Webhook will include all account details including financial transactions, the newly updated account balance, and also refreshes all recent transaction data. Also, once a user is successfully connected through the widget, the following webhook event is sent:


API object

  event: '',
  data: {
    meta: {
      data_status: 'AVAILABLE',
      auth_method: 'mobile_banking'//internet_banking
    account: {
      _id: '5fbcde8f8699984153e65537',
      institution: {
        "name": "GTBank",
        "bankCode": "058",
        "type": "PERSONAL_BANKING"
      accountNumber: '0018709596',
      type: 'SAVINGS_ACCOUNT',
      currency: 'Naira',
      bvn: '9422',
      balance: 3033984,
      created_at: '2020-11-24T10:21:03.936Z',
      updated_at: '2020-11-24T10:21:13.050Z',
      __v: 0

Fields for balance webhooks

Field description type
event The webhook event action that triggered the webhook, e.g. string
data All information related to this specific webhook object
data.meta An event object containing the account data and the current status object
data.meta.data_status The status of the current connected data, if it is AVAILABLE, PROCESSING, FAILED string
data.meta.auth_method This refers to the authentication method used by user. It returns either, mobile_banking or internet_banking string
data.account An object with all account data object
data.account._id The unique identifier for the member which has new or updated transaction data string
data.account.institution All data related to the financial institution of the connected user object The institution name of the connected account string
data.account.institution.bankCode The bank code of the institution name connected to this account string
data.account.institution.type The type of banking method for this connected user. E.g PERSONAL_BANKING, BUSINESS_BANKING etc string
data.account.accountNumber The account number of the connected user string The account name of the connected user string
data.account.type The account type of the connected user E.g SAVINGS ACCOUNT, CURRENT ACCOUNT string
data.account.currency The curency of the connected user string
data.account.bvn The BVN of the connected user string
data.account.balance The current account balance of the connected user string
data.account.created_at The date the webhook object was created string
data.account.updated_at The date the webhook object was updated string

Did this page help you?