Payouts events

Webhook Event Model

Field	Type	Description	Nullable
event.type	Enum(String)	Type of webhook event: 'payout_received', 'payout_cancelled', 'payout_failed', 'payout_completed'	false
data	Payouts	Transaction Details	false

Sample successful webhook event response

JSON

{
  "event.type": "payout_received",
  "data": {
    "id": 1738,
    "amount": 5,
    "uid": 7,
    "businessId": 6,
    "walletId": 39,
    "bankId": 644,
    "refid": "33616792301",
    "currency": "NGN",
    "channel": "bank",
    "status": "pending",
    "meta": {
      "bank": {
        "id": 644,
        "uid": 7,
        "businessId": 6,
        "defaultBank": false,
        "maskedaccountnumber": "*****678314",
        "bankname": "GUARANTY TRUST BANK",
        "beneficiaryname": "SALAMI MURITALA OLAYIWOLA",
        "beneficiarycountry": "NGN",
        "type": "bank",
        "email": null,
        "createdAt": "2023-04-29T13:49:01.000Z",
        "updatedAt": "2023-04-29T13:49:01.000Z",
        "deletedAt": null
      },
      "total": 5,
      "fee": [
        {
          "percent": false,
          "fee": 0,
          "reason": "payout-charge"
        }
      ]
    },
    "updatedAt": "2023-06-30T20:48:56.217Z",
    "createdAt": "2023-06-30T20:48:56.217Z"
  }
}

Sample cancelled webhook event response

JSON

{
  "event.type": "payout_cancelled",
  "data": {
    "id": 1734,
    "uid": 7,
    "businessId": 6,
    "walletId": 39,
    "amount": 5,
    "refid": "69506479732",
    "bankId": 644,
    "channel": "bank",
    "currency": "NGN",
    "meta": {
      "fee": [
        {
          "fee": 0,
          "reason": "payout-charge",
          "percent": false
        }
      ],
      "bank": {
        "id": 644,
        "uid": 7,
        "type": "bank",
        "email": null,
        "bankname": "GUARANTY TRUST BANK",
        "createdAt": "2023-04-29T13:49:01.000Z",
        "deletedAt": null,
        "updatedAt": "2023-04-29T13:49:01.000Z",
        "businessId": 6,
        "defaultBank": false,
        "beneficiaryname": "SALAMI MURITALA OLAYIWOLA",
        "beneficiarycountry": "NGN",
        "maskedaccountnumber": "*****678314"
      },
      "total": 5
    },
    "status": "cancelled",
    "providerId": null,
    "provider": null,
    "reason": null,
    "createdAt": "2023-06-30T20:39:10.000Z",
    "updatedAt": "2023-07-05T13:03:31.572Z",
    "deletedAt": null
  }
}

Sample failed webhook event response

JSON

{
  "event.type": "payout_failed",
  "data": {
    "id": 1734,
    "uid": 7,
    "businessId": 6,
    "walletId": 39,
    "amount": 5,
    "refid": "69506479732",
    "bankId": 644,
    "channel": "bank",
    "currency": "NGN",
    "meta": {
      "fee": [
        {
          "fee": 0,
          "reason": "payout-charge",
          "percent": false
        }
      ],
      "bank": {
        "id": 644,
        "uid": 7,
        "type": "bank",
        "email": null,
        "bankname": "GUARANTY TRUST BANK",
        "createdAt": "2023-04-29T13:49:01.000Z",
        "deletedAt": null,
        "updatedAt": "2023-04-29T13:49:01.000Z",
        "businessId": 6,
        "defaultBank": false,
        "beneficiaryname": "SALAMI MURITALA OLAYIWOLA",
        "beneficiarycountry": "NGN",
        "maskedaccountnumber": "*****678314"
      },
      "total": 5
    },
    "status": "failed",
    "providerId": null,
    "provider": null,
    "reason": null,
    "createdAt": "2023-06-30T20:39:10.000Z",
    "updatedAt": "2023-07-05T13:03:31.572Z",
    "deletedAt": null
  }
}

Sample Successful Webhook event response

Json

{
  "event.type": "payout_completed",
  "data": {
    "id": 1734,
    "uid": 7,
    "businessId": 6,
    "walletId": 39,
    "amount": 5,
    "refid": "69506479732",
    "bankId": 644,
    "channel": "bank",
    "currency": "NGN",
    "meta": {
      "fee": [
        {
          "fee": 0,
          "reason": "payout-charge",
          "percent": false
        }
      ],
      "bank": {
        "id": 644,
        "uid": 7,
        "type": "bank",
        "email": null,
        "bankname": "GUARANTY TRUST BANK",
        "createdAt": "2023-04-29T13:49:01.000Z",
        "deletedAt": null,
        "updatedAt": "2023-04-29T13:49:01.000Z",
        "businessId": 6,
        "defaultBank": false,
        "beneficiaryname": "SALAMI MURITALA OLAYIWOLA",
        "beneficiarycountry": "NGN",
        "maskedaccountnumber": "*****678314"
      },
      "total": 5
    },
    "status": "completed",
    "providerId": null,
    "provider": null,
    "reason": null,
    "createdAt": "2023-06-30T20:39:10.000Z",
    "updatedAt": "2023-07-05T13:03:31.572Z",
    "deletedAt": null
  }
}