Documentation
Webhooks
Collections Webhooks

Collections Webhooks

When collections are completed, webhooks are sent to notify the settlement status.
The expected webhook events are

  1. collection.deposit.success - This is sent when the collection transaction is successful
  2. collection.deposit.failed - This is sent when the collection transaction fails

Here are samples of webhooks sent for these events:

Collection deposit success [Event]
{
  "event": "collection.deposit.success",
  "data": {
    "id": "52797f57-9c28-4078-a76c-16c3f2c2a242",
    "fees": "0",
    "type": "credit",
    "amount": "650",
    "action": "deposit_ngn",
    "status": "success",
    "channel": "collection",
    "reference": "90c510c6-29f2-499e-a7ac-32474f6dcc77",
    "companyId": "be18709e-8109-4717-bb1c-2a3e2711e6b1",
    "callbackUrl": null
  }
}

Collection deposit failed [Event]
{
  "event": "collection.deposit.failed",
  "data": {
    "id": "74216fcc-386a-42ce-b93d-2e4lh4of54",
    "fees": "0",
    "type": "credit",
    "action": "deposit_ugx",
    "amount": "510",
    "status": "failed",
    "channel": "collection",
    "companyId": "be10439e-8109-4717-bb1c-2a7d0066b1",
    "reference": "c46c4252c8f0",
    "callbackUrl": null
  }
}
Payouts WebhookCustomers