Documentation
Payouts Webhook

Payout Webhooks

Payout webhooks are fired when there is a transfer of funds


Payout Transfer Success

This is a webhook that is fired when the transfer of funds is successful.

JSON
{
  "event": "payout.transfer.success",
  "data": {
    "fees": "0",
    "type": "debit",
    "amount": "35.81",
    "status": "success",
    "channel": "payout",
    "reference": "45b873bd49fa",
    "action": "ngn_account_payout",
    "id": "1ad3d098-e6f4-4811-9a74-ae5371b3d722",
    "companyId": "45422f21-9a0e-479e-9e10-615556448a78",
    "callbackUrl": ""
  }
}
 

Payout Transfer Failed

This is a webhook that is fired when the transfer of funds is unsuccessful.

JSON
{
  "event": "payout.transfer.failed",
  "data": {
    "fees": "0",
    "type": "debit",
    "amount": "30",
    "status": "failed",
    "channel": "payout",
    "reference": "93b873bd49bd",
    "action": "ghs_account_payout",
    "id": "1033d098-e6f4-4811-9a74-ae5371b3j052",
    "companyId": "45422f21-9a0e-479e-9e10-615556448a78",
    "callbackUrl": ""
  }
}