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": "a6d78e22-2f76-469e-bd84-205ebdda9h5a",
  "event": "payout_initiated",
  "resource_type": "payout",
  "data": {
    "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
    "business_id": "57abd051-80cf-4b41-a7d9-06fdc5f3a5d7",
    "status": "initiated",
    "count": 1,
    "currency": "NGN",
    "total_amount": 59450,
    "fee": {
      "currency": "NGN",
      "symbol": "₦",
      "amount": 90
    },
    "remarks": "00046",
    "cancel_reason": null,
    "actor": "business",
    "actor_id": "261766b4-f136-4b80-a85e-f1a77034f9a2",
    "is_recurring": false,
    "schedule_details": null,
    "completed_at": null,
    "created_at": "2023-10-30T17:23:06.797603512+01:00",
    "updated_at": "2023-10-30T17:23:06.804121436+01:00"
  }
}

Payout approved

{
  "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
  "event": "payout_approved",
  "resource_type": "payout",
  "data": {
    "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
    "business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
    "status": "processing",
    "count": 1,
    "currency": "NGN",
    "total_amount": 59450,
    "fee": {
      "currency": "NGN",
      "symbol": "",
      "amount": 90
    },
    "remarks": "00046",
    "cancel_reason": null,
    "actor": "business",
    "actor_id": "261766b4-f136-4b80-a85e-f1a77034f9a2",
    "is_recurring": false,
    "schedule_details": null,
    "complete_at": null,
    "created_at": "2023-10-30T18:23:06.797603+01:00",
    "updated_at": "2023-10-30T17:23:06.873553247+01:00"
  }
}

Payout completed

{
  "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
  "event": "payout_completed",
  "resource_type": "payout",
  "data": {
    "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
    "business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
    "status": "completed",
    "count": 1,
    "currency": "NGN",
    "total_amount": 59450,
    "fee": {
      "currency": "NGN",
      "symbol": "",
      "amount": 90
    },
    "remarks": "00046",
    "cancel_reason": null,
    "actor": "business",
    "actor_id": "261766b4-f136-4b80-a85e-f1a77034f9a2",
    "is_recurring": false,
    "schedule_details": null,
    "completed_at": null,
    "created_at": "2023-10-30T18:23:06.797603+01:00",
    "updated_at": "2023-10-30T18:23:06.873553+01:00"
  }
}

Bulk payout cancelled

{
  "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
  "event": "payout_cancelled",
  "resource_type": "payout",
  "data": {
    "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
    "business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
    "status": "cancelled",
    "count": 1,
    "currency": "NGN",
    "total_amount": 59450,
    "fee": {
      "currency": "NGN",
      "symbol": "",
      "amount": 90
    },
    "remarks": "00046",
    "cancel_reason": "no stress me",
    "actor": "business",
    "actor_id": "261766b4-f136-4b80-a85e-f1a77034f9a2",
    "isRecurring": false,
    "schedule_details": null,
    "completed_at": null,
    "created_at": "2023-10-30T18:23:06.797603+01:00",
    "updated_at": "2023-10-30T18:23:06.873553+01:00"
  }
}

Account validation failed

{
  "id": "a6d78e22-2f76-469e-bd84-205ebdda8a5a",
  "event": "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"
}
}