Payout

Overview

Payout webhooks provide lifecycle updates for bank transfers. The current payout event types are:

payout.completed
payout.failed
payout.processed
payout.processing
payout.reversed

Use the payout reference and transaction status to reconcile the transfer. Do not treat the initial payout request as final settlement.

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 fails.

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"
  }
}

Get Started

Wallet

Transaction

Customer

Card

Collection

FX

Webhook Events

Payout

Overview

Completed webhook event

Failed webhook event

​Overview

​Completed webhook event

​Failed webhook event

Overview

Completed webhook event

Failed webhook event