​
Overview

Our collection webhook events are fired based on the following triggers:

  • Completed webhook event
  • Collection created event
  • Collection created failed event

​
Completed webhook event

collection.completed
{
  "event": "collection.completed",
  "data": {
    "id": "txn_zRo4J1WQU6bvvh2umYwA",
    "reference": "ref_zWkNkNFhbK3igZ8bDtEu",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "COMPLETED",
    "amount": 500000,
    "charges": 1000,
    "type": "CREDIT",
    "detail": "Fund wallet",
    "created_at": "2024-03-13T21:00:28Z",
    "updated_at": "2024-03-13T21:00:28Z"
  }
}

​
Completed created event

collection.created
{
  "event": "collection.created",
  "data": {
    "wallet_id": "string",
    "business_id": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_name": "string",
    "account_name": "string",
    "routing_number": "string",
    "account_type": "string",
    "bank_address": "string",
  }
}

​
Completed created failed event

collection.created.failed
{
  "event": "collection.created.failed",
  "data": {
    "collection": {
      "wallet_id": "string",
      "business_id": "string",
      "account_number": "string",
      "bank_code": "string",
      "bank_name": "string",
      "account_name": "string",
      "routing_number": "string",
      "account_type": "string",
      "bank_address": "string",
    },
    "reasons": [
      {
        "reason": "Invalid tax number"
      }
    ]
  }
}

Was this page helpful?

CustomerPayout