​
Overview

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

  • Completed webhook event

  • Failed webhook event

​
Completed webhook event

This event is fired when a payout is completed.

payout.completed
{
  "event": "payout.completed",
  "data": {
    "id": "txn_LKkX3akrzdpJpfA2WGc5",
    "reference": "ref_ZwfWk6AfTb42GTibd4yG",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "COMPLETED",
    "amount": 500000,
    "charges": 20,
    "type": "DEBIT",
    "detail": "God help us",
    "created_at": "2024-03-12T15:09:24Z",
    "updated_at": "2024-03-12T14:24:07Z"
  }
}

​
Failed webhook event

This event is fired when a payout is failed.

payout.failed
{
  "event": "payout.failed",
  "data": {
    "id": "txn_LKkX3akrzdpJpfA2WGc5",
    "reference": "ref_ZwfWk6AfTb42GTibd4yG",
    "business_id": "bsn_fAYcWSUXz3TogChv7BgH",
    "status": "FAILED",
    "amount": 500000,
    "charges": 20,
    "type": "DEBIT",
    "detail": "God help us",
    "created_at": "2024-03-12T15:09:24Z",
    "updated_at": "2024-03-12T14:24:07Z"
  }
}

Was this page helpful?

Suggest editsRaise issue
CollectionWallet