Payouts Webhook
A request is to be sent from Munify to the customers’ webhook_url endpoint, which the customer sets in the dashboard. The webhook will be sent upon any update on the payout status. The customer is expected to implement the endpoint.
- The webhook will be sent and expects a
200response status code to be considered as received, otherwise, it will retry sending 2 times with a retry backoff of 1 second. - If 3 sending trails yelled unsuccessful delivery, no more trails will be carried out, and it will be the customer’s responsibility to fetch the new status using the 2. List Payouts endpoint.
- The webhook is sent with a
webhook_secretheader, to verify the sender.
Method
POST
URL
This is to be configured by the customer in the dashboard Webhook settings section.
Headers
| Key | Value |
|---|---|
WEBHOOK_SECRET | Customer’s webhook secret available in the webhook settings section in the dashboard. |
Request Fields
| Field | Type | Description |
|---|---|---|
webhook_event_id | UUID | Webhook’s event Identifier. |
webhook_event_timestamp | Datetime (Iso Format) | Webhook’s event Timestamp. |
payout_id | UUID | Munify’s Payout Identifier. |
payout_customer_reference | String | Customer’s Payout Reference (Sent on initiating the payout). |
payout_amount | Decimal | Payout Actual Amount. |
payout_currency | Enum (Currency) | Payout Currency Code. |
payout_receiver_identifier | String | Payout Receiver Identifier. (Wallet Phone Number, Bank Account Number, Card Number) |
payout_receiver_name | String | Payout Receiver Name. |
payout_type | Enum (Payout Types) | Payout Type Enum Value. |
payout_bank_code | Enum (Bank Codes) | Payout Receiver Bank Code. |
payout_status | Enum (Payout Status) | Payout Status Enum Value. |
payout_failure_reason | String | The reason behind failure if any. |
Request Example
{
"webhook_event_id": "1ec567f1-4696-49af-9c0a-8e3b87d8380c",
"webhook_event_timestamp": "2024-08-07T16:25:32.495071Z",
"payout_id": "37c23ed0-5001-11ef-9454-0242ac120002",
"payout_customer_reference": "123456",
"payout_amount": 1576.85,
"payout_currency": "EGP",
"payout_receiver_identifier": "12345678901234",
"payout_receiver_name": "Ali Ahmed Mohamed Ahmed",
"payout_type": "BANK_ACCOUNT",
"payout_bank_code": "CIB",
"payout_status": "SETTLED",
"payout_failure_reason": null
}