Virtual Account Services
  1. Notifications
Virtual Account Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Create Account
      POST
    • Rename Account
      POST
    • Balance Inquiry
      GET
    • Create Bulk Accounts
      POST
    • List Accounts
      GET
  • Transaction
    • Credit Account
      POST
    • Debit Account
      POST
    • Credit Account [Agency Banking]
      POST
    • Debit Account [Agency Banking]
      POST
    • Transaction Query
      GET
    • Transaction Details
      GET
    • Transaction History
      GET
  • Transfer
    • Get Institutions
      GET
    • Name Inquiry
      POST
    • Interbank Transfer
      POST
    • Interbank Transfer [Sync]
      POST
    • Transfer Query
      GET
    • Transfer Enquiry
      GET
    • Virtual Account Intrabank Transfer
      POST
    • Core Banking Intrabank Transfer
      POST
    • Collection Accounts Intrabank Transfer
      POST
  • Invoice
    • Create Invoice
    • Get Invoice Detail
    • List Merchant Invoices
  • Refunds
    • Initiate Refund
    • Get Refund Status
    • Get Refunds
  • Notifications
    • Notification
    • Send Notification
      POST
  • Merchant
    • Account
      • Get Account
      • Activate Sub Ledger For Merchant
      • Get SubLedger Callback Urls
      • Set SubLedger Callback Urls
      • Get Collection Accounts
    • Transfer
      • Get Transfer History
      • Get Subledger transfers
      • Get Transfer Details
      • Name Inquiry
    • Refund
      • Refund Details
  • Admin
    • Accounting
      • Get GL Accounts
      • Get Classification Codes
    • Dashboard
      • Dashboard Summary
      • Dashboard Transactions
      • Dashboard Transaction Details
    • Group Codes
      • Get Group Codes
      • Set Collection Account
      • Create Group Code
    • Reporting
      • Get Report Types
      • Get Report Parameters
      • Create Report
      • Get Reports
      • Get Reports Details
  1. Notifications

Notification

This document provides a sample payload for transaction notifications. It outlines the structure and fields that are included in a transaction notification message to a webhook.
Use this as a reference for building, testing, or consuming transaction notifications within your system.

Paylaod Body Fields#

Field NameTypeRequiredDescription
account_numberstringYesThe account number involved in the transaction.
amountstring or numberYesThe transaction amount. This value may be provided as a string or a numeric type.
sourceBankNamestringYesThe name of the bank initiating the transaction.
transactionStatusstringYesThe status of the transaction (e.g., CONFIRMED, PENDING).
transactionReferencestringYesA unique reference identifier for the transaction.
session_idstringYesThe session identifier, which typically matches the transaction reference.
typestringYesThe type of the transaction (e.g., Normal), indicating the nature of the transaction.
destinationAccountNUBANstringYesThe NUBAN number for the destination account.
destinationAccountNamestringYesThe name of the destination account holder.
destinationInstitutionCodestringYesThe institution code for the destination financial institution.
narrationstringNoOptional additional details or notes about the transaction.
sourceAccountNUBANstringYesThe NUBAN number for the source account.
namestringYesThe name associated with the notification, typically reflecting the destination account name.
sourceInstitutionCodestringYesThe institution code for the source financial institution.
destinationBankNamestringYesThe name of the bank receiving the transaction.
sourceAccountNamestringYesThe name of the source account holder.

Payload Example#

{
    "account_number": "9000003702",
    "amount": "100.0",
    "sourceBankName": "STANBIC IBTC BANK PLC",
    "transactionStatus": "CONFIRMED",
    "transactionReference": "000012240813141505939055370222",
    "session_id": "000012240813141505939055370222",
    "type": "Normal",
    "destinationAccountNUBAN": "9000003702",
    "destinationAccountName": "Customer 1",
    "destinationInstitutionCode": "090682",
    "narration": "Hi",
    "sourceAccountNUBAN": "0040088210",
    "name": "Customer 1",
    "sourceInstitutionCode": "000012",
    "destinationBankName": "BUY POWER MFB",
    "sourceAccountName": "MOHAMMED BALARABE OLATEJU"
}

This document serves as a guide for the expected structure of transaction notification payloads. Adjustments may be necessary depending on your specific implementation needs.
Modified at 2025-04-02 12:11:40
Previous
Get Refunds
Next
Send Notification
Built with