API Reference

Payout Webhooks

This API is used to get webhooks for payouts. Webhooks for payouts are a mechanism for receiving real-time notifications about events related to payout transactions.

Payout initiated

{
   "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
   "event": "payout.initiated",
   "resource_type": "payout",
   "data": {
      "business_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
      "cancel_reason": null,
      "completed_at": null,
      "count": 2,
      "created_at": "2024-04-19T13:34:37.382674+01:00",
      "currency": "GHS",
      "fee": {
         "amount": 90,
         "currency": "GHS",
         "symbol": "₵"
      },
      "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
      "is_recurring": false,
      "payout_type": "single",
      "remarks": "remarks",
      "status": "awaiting_business_approval",
      "total_amount": 4500,
      "updated_at": "2024-04-19T13:34:37.63197+01:00"
   },
   "live": false,
   "timestamp": 1713530081
}

Payout approved

{
   "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
   "event": "payout.approved",
   "resource_type": "payout",
   "data": {
      "business_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
      "cancel_reason": null,
      "completed_at": null,
      "count": 2,
      "created_at": "2024-04-19T13:34:37.382674Z",
      "currency": "GHS",
      "fee": {
         "amount": 90,
         "currency": "GHS",
         "symbol": ""
      },
      "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
      "is_recurring": false,
      "payout_type": "single",
      "remarks": "remarks",
      "status": "processing",
      "total_amount": 4500,
      "updated_at": "2024-04-19T13:39:18.715703+01:00"
   },
   "live": false,
   "timestamp": 1713530360
}

Payout completed

{
   "id": "933f4c7f-5340-450c-b153-ebab57dca056",
   "event": "payout.completed",
   "resource_type": "payout",
   "data": {
      "business_id": "17921a1a-72ba-4f01-bce2-6ae30ac1b403",
      "cancel_reason": null,
      "completed_at": "2024-04-21T23:05:35.301308Z",
      "count": 5,
      "created_at": "2024-04-21T23:04:21.332076Z",
      "currency": "NGN",
      "fee": {
         "amount": 10452.2,
         "currency": "NGN",
         "symbol": ""
      },
      "id": "933f4c7f-5340-450c-b153-ebab57dca056",
      "is_recurring": false,
      "payout_type": "multiple",
      "remarks": "May Baker",
      "status": "completed",
      "total_amount": 95020,
      "updated_at": "2024-04-21T23:05:35.301308Z"
   },
   "live": false,
   "timestamp": 1713737135
}

Payout Cancelled

{
   "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
   "event": "payout.cancelled",
   "resource_type": "payout",
   "data": {
      "business_id": "923b2df5-4a89-4ceb-b148-c2e5ac52d04e",
      "cancel_reason": null,
      "completed_at": null,
      "count": 2,
      "created_at": "2024-04-19T13:34:37.382674Z",
      "currency": "GHS",
      "fee": {
         "amount": 90,
         "currency": "GHS",
         "symbol": ""
      },
      "id": "c1c856b0-e675-4b58-bbff-a86892d95417",
      "is_recurring": false,
      "payout_type": "single",
      "remarks": "remarks",
      "status": "processing",
      "total_amount": 4500,
      "updated_at": "2024-04-19T13:39:18.715703+01:00"
   },
   "live": false,
   "timestamp": 1713530360
}

Account validation failed

{
  "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
  "event": "payout.account_validation_failed",
  "resource_type": "payout",
  "data": {
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "business_id": "550e8400-e29b-41d4-a716-446655441111",
  "bulk_payout_id": "560e8400-e29b-41d4-a716-446655442222",
  "name": "Sample Account",
  "details": {
    "account_number": "123456789",
    "account_name": "John Doe",
    "routing_number": "",
    "swift_code": "",
    "bank_name": "Sample Bank",
    "bank_code": "123",
    "bank_branch": "",
    "country": "Nigeria",
    "city": "Lagos",
    "bank_address": "123 Main Street",
    "district": "",
    "postal_code": "10001",
    "is_within_US": "no",
    "is_mobile_money": "no"
  },
  "amount": {
    "currency": "NGN",
    "value": 1000
  },
  "status": "needs_update",
  "lookup_info": "Lookup Information",
  "remarks": "Sample Remarks",
  "notes": "Sample Notes",
  "completed_at": "2023-11-10T12:34:56Z",
  "created_at": "2023-11-10T10:00:00Z",
  "updated_at": "2023-11-10T11:30:00Z"
}
}