> For the complete documentation index, see [llms.txt](https://startbutton.gitbook.io/startbutton-product-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://startbutton.gitbook.io/startbutton-product-api/webhooks/collection-events.md).

# Collection Events

### Supported events for payment collection:

1. collection.verified
2. collection.completed

{% tabs %}
{% tab title="Verified" %}

```json
{
  "event": "collection.verified",
  "data": {
    "transaction": {
      "_id": "65042a1a0d32920xxxxxxxxx",
      "transType": "collection",
      "status": "verified",
      "merchantId": "64c7bd870821e83xxxxxxxxx",
      "transactionReference": "be6eaxxxxxxx",
      "customerEmail": "test@customer.com",
      "userTransactionReference": "aedxxxx",
      "paymentCode": "a78a18df1fdc1fa7f2fb665b54afa21cf1c0d81b741f44527989f492e2a6094cdb24281fb7d577c4636978xxxxxxxxxx",
      "isRecurrent": false,
      "postProcess": null,
      "gatewayReference": null,
      "createdAt": "2023-09-15T09:55:38.492Z",
      "updatedAt": "2023-09-15T09:57:30.522Z",
      "feeAmount": 115500,
      "narration": "Approved",
      "amount": 1030000,
      "currency": "ZAR"
    },
    "authorizationCode": null
  }
}
```

{% endtab %}

{% tab title="Completed" %}

```json
{ 
  "event": "collection.completed", 
  "data": { 
    "transaction": { 
      "_id": "65042a1a0d3292066xxxxxxx", 
      "transType": "collection", 
      "status": "successful", 
      "merchantId": "64c7bd870821e831cxxxxxxx", 
      "transactionReference": "be6eaxxxxxxx", 
      "customerEmail": "test@customer.com", 
      "userTransactionReference": "aedxxxx", 
      "paymentCode": "a78a18df1fdc1fa7f2fb665b54afa21cf1c0d81b741f44527989f492e2a6094cdb24281fb7d577c4636978xxxxxxxxxx", 
      "isRecurrent": false, 
      "postProcess": null, 
      "gatewayReference": null, 
      "createdAt": "2023-09-15T09:55:38.492Z", 
      "updatedAt": "2023-09-15T09:59:01.089Z", 
      "feeAmount": 115500, 
      "narration": "Successful", 
      "amount": 1030000, 
      "currency": "ZAR" 
    }, 
    "authorizationCode": null 
  } 
}
```

{% endtab %}
{% endtabs %}

`amount` is in fractional unit

### Webhook for DVA top-up:

When top-up is done to your DVA, you should expect this webhook format:

```json
{ 
  "event": "topup.successful", 
  "data": { 
    "transaction": { 
      "_id": "68e38f170899ef52f107dcc1", 
      "transType": "topup", 
      "status": "successful", 
      "feeAmount": 4200, 
      "merchantId": "6569d0c4bxxxxxxxxxx", 
      "transactionReference": "25b8exxxxx", 
      "customerEmail": "Topup account", 
      "paymentPartnerId": "65c1e6e7dcaa5xxxxxxx", 
      "isRecurrent": false, 
        "dvaAccountNumber": "0123456778",
      "createdAt": "2025-10-06T09:42:47.659Z", 
      "updatedAt": "2025-10-06T09:42:47.659Z", 
      "amount": 200000, 
      "currency": "NGN", 
      "initialAmount": 200000, 
      "narration": "Topup account" 
    }, 
    "authorizationCode": null, 
    "payerInformation": { 
      "sessionId": "", 
      "accountNumber": "******0000", 
      "bankName": "TEST BANK" 
    } 
  } 
}
```