Skip to main content

​
Webhook Event : collection.completed

This event notifies you when funds have been successfully collected, meaning a merchant’s wallet has been successfully funded. This typically happens after a customer payment is settled.

​
Sample Payload

{
  "event": "<event name i.e collection.completed>",
  "data": {
    "id": "866be9f6-1e3c-4083-87a5-xxxxxxxxxxxxx",
    "referenceNumber": "V6FUNZNGIVXXX",
    "amount": 100,
    "fee": {
      "vat": 2,
      "stampDuty": 2,
      "base": 2
    },
    "settlementAmount": 94.00,
    "type": "FUNDING",
    "state": "COMPLETED",
    "destination": "NGN wallet",
    "source": {
      "bankName": "Mock Bank",
      "accountName": "Jane Doe",
      "accountNumber": "25078429XXXX"
    },
    "created": "2023-08-16T23:12:28.256678",
    "processed": "2023-08-16T23:12:28.256678"
  }
}

​
Payload Breakdown

FieldTypeDescription
eventstringThe name of the event that occurred (e.g., “collection.completed”).
data.idstringUnique identifier for the transaction.
data.referenceNumberstringUnique reference number assigned to the transaction.
data.amountnumberThe total gross amount of the transaction.
data.fee.vatnumberThe Value Added Tax portion of the fee.
data.fee.stampDutynumberThe stamp duty portion of the fee.
data.fee.basenumberThe base fee for the transaction.
data.settlementAmountnumberThe final amount settled after deducting all fees.
data.typestringThe type of transaction (e.g., “FUNDING”).
data.statestringThe final state of the transaction (e.g., “COMPLETED”).
data.destinationstringThe destination of the funds (e.g., “NGN wallet”).
data.source.bankNamestringThe name of the source bank or financial institution.
data.source.accountNamestringThe name on the source account.
data.source.accountNumberstringThe account number or identifier of the source.
data.createdstringISO 8601 timestamp of when the transaction was created.
data.processedstringISO 8601 timestamp of when the transaction was processed.