Settlements

Settlement Notification

4min

Introduction
When a settlement is created and sent to the merchant bank account, Moyasar will send a webhook notification to the merchant (if configured).
This feature is only available for Moyasar aggregation clients, this is not available for bank mercahnts.
﻿
Setting up 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.
JSON
{
  "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"
  }
}
{
  "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"
  }
}
﻿
﻿

Updated 18 Feb 2024

Did this page help you?

Using API

Facilitation Merchants

Settlement Notification

Introduction

Setting up Settlement Webhooks

﻿

Message Example