Skip to main content
This webhook event notifies your application about specific events happening in the system. The event contains metadata and detailed payload information.

​
Event Schema

FieldTypeDescription
eventTypestringType of event triggered COLLECTION
statusstringCurrent status of the event (e.g., SUCCESS, FAILED)
payload.methodstringPayment method used (e.g., credit_card)
payload.transactionIdstringInternal transaction identifier
payload.walletIdstringUnique identifier of the wallet
payload.entityIdstringID of the associated business or user
payload.entityTypestringType of entity (e.g., USER, BUSINESS)
payload.summarystringSummary of the transaction
payload.entrystringTransaction entry type (e.g., CREDIT)
payload.amountstringTransaction amount
payload.currencystringCurrency of the transaction (e.g., USD)
payload.timestampnumberTimestamp of the event (in milliseconds)
payload.metadataobjectAdditional metadata for the transaction

​
Example Payload

{
  "eventType": "COLLECTION",
  "status": "SUCCESS",
  "payload": {
    "method": "credit_card",
    "transactionId": "TXN123456789",
    "walletId": "WALLET987654321",
    "entityId": "BUSINESS001",
    "entityType": "USER",
    "summary": "Payment completed successfully",
    "entry": "CREDIT",
    "amount": "100.00",
    "currency": "USD",
    "timestamp": 1716895327614,
    "metadata": {
        "customerId": "CUST12345",
        "orderId": "456"
      }
    }
}