Skip to main content
When your NGN collections are confirmed, details about the transaction are sent in a payload that provides essential information for record-keeping and reconciliation. These are sent to your collection_url when your business receives funds.

​
Parameter overview

ParameterDescription
messageIndicates the status of the transaction.
transaction_idA unique identifier for the transaction.
transaction_referenceA unique identifier for the transaction.
transaction_statusThe status of the transaction (e.g., SUCCESSFUL).
transaction_feeThe fee charged for the transaction.
transaction_amount_without_feeThe amount sent excluding fees.
transaction_amountThe total amount including fees.
transaction_currencyThe currency in which the transaction is conducted (NGN).
source_informationAn object containing details about the source of the funds.
source_information.account_numberThe account number of the sender who initiated the collection.
source_information.account_nameThe account name of the sender who initiated the collection.
source_information.bank_nameThe bank name of the sender who initiated the collection.
virtual_bank_accountAn object containing details about the virtual account that was credited.
virtual_bank_account.account_numberThe account number of the virtual bank account that was credited.
virtual_bank_account.account_nameThe account name of the virtual bank account that was credited.
event_idA unique identifier for the event.
typeThe type of transaction (e.g., collection).

​
Example payload

{
  "message": "Transaction Completed",
  "transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
  "transaction_reference": "90980e50-0b83-40a6-aa46-ac8e795b1acd",
  "transaction_status": "SUCCESSFUL",
  "transaction_fee": 39.12,
  "transaction_amount_without_fee": 612.88,
  "transaction_amount": 652.0,
  "transaction_currency": "NGN",
   "virtual_bank_account": {
    "id": "vba_xyz789",
    "account_number": "1234567890",
    "account_name": "Your Business Name",
    "bank_name": "Access Bank"
  },
  "source_information": {
    "account_number": "9876543210",
    "account_name": "John Doe",
    "bank_name": "GTBank"
  },
  "event_id": "9d46b957-0cf5-4743-847a-254d92de6a85",
  "type": "collection"
}