Settlement Notification

When a settlement is created and sent to the merchant bank account, Moyasar will send a webhook notification to the merchant (if configured).

tip

This feature is only available for Moyasar aggregation clients, this is not available for bank mercahnts.

Configure Settlement Webhooks

To setup the settlement webhook, you will need to do the following steps:

• Login into your live account dashboard
• Navigate to Settings
• Navigate to Webhooks tab
• Add a new webhook
• Make sure to selected the balance_transferred event.

You can learn more about webhooks and how they work here: Webhook Reference

Message Example

A webhook message for balance transferred will look like the following example:

The transfer ID can be found in the element data.id.

{
  "id": "762760de-4ac3-44a0-8cec-ba44ebaf670a",
  "type": "balance_transferred",
  "created_at": "2024-02-18T15:57:27+00:00",
  "secret_token": "123",
  "account_name": "Test Merchant",
  "live": true,
  "data": {
    "id": "10af7e38-0af8-4c56-be5d-366ee0efcd86",
    "recipient_type": "Entity",
    "recipient_id": "29153d68-55d9-4afc-b4fe-a68301b468c9",
    "currency": "SAR",
    "amount": 561743,
    "fee": 0,
    "tax": 0,
    "reference": null,
    "transaction_count": 2,
    "created_at": "2023-09-06T15:46:35.518Z"
  }
}