Webhook Notifications
Get automatic updates and information on virtual accounts
Virtual Accounts Webhook Notification API service provides a seamless way to stay updated with real-time events and transactions related to your virtual accounts. Instead of manually polling APIs, webhooks push instant notifications directly to your application whenever specific actions occur, enabling faster and automated responses.
Webhook notification provides you with information on:
- Transaction notification (Debit/Credit)
- Transaction details
Important information
- Responding to the webhook notification you receive
It is required to acknowledge the received webhook by sending a JSON response as as{status: "OK"}
.
Virtual Account Transaction Webhook Notification
{
"svWebhookNotificationServiceRQ": {
"company": [
{
"companyCode": "1101",
"notifications": [
{
"type": "CREDIT", // CREDIT/DEBIT
"timestamp": "2025-08-01T05:49:52.715Z",
"AccountNumber": SA5100012680407123456789,
"acERPcode": "T1T2",
"Amount": 11000,
"Currency": "SAR",
"CustomerRefNo": 123247908,
"TransactionReference": 123456789247908,
"Description": "Incoming internal transfer",
"TransactionSource": 14000001122337408,
"ValueDate": 230621,
"DateTime": 2306211622,
"RemitterId": "20050162914321"
}
]
}
]
}
}
Response description:
JSON Tag | Description | Data type |
---|---|---|
svWebhookNotificationServiceRQ | Root tag containing webhook notification response | Object |
company | Tag carrying information about the company | Object |
companyCode | Unique company identification code | String |
notification | Tag carrying information on the transaction | Object |
type | Type of transaction in the account mentioned as CREDIT or DEBIT | Alphabetic |
timestamp | Date and time of transaction in YYYY-MM-DDTHH:MM:SS.SSSZ format | Date |
AccountNumber | Virtual account identification number | Alphanumeric |
acERPcode | Unique account identification code linked in ERP | Alphanumeric |
Amount | Transaction amount | Numeric |
Currency | Currency of the transaction | Alphabetic |
CustomerRefNo | Unique customer reference number for the transaction | String |
TransactionReference | Unique transaction reference number | String |
Description | Details about the transaction | String |
TransactionSource | Unique transaction source identification details | String |
ValueDate | Date representing the transaction initiation | Numeric |
DateTime | Date and time representing the transaction settlement YYMMDDHHMM | Numeric |
RemitterId | Unique remitter identification details | String |
Expected Response
{
Status:"OK"
}
Updated 12 days ago