Account balance change notification
A notification informing you when the balance of an account changes.
Notification parameters
Parameter | Type | Description |
---|---|---|
NotificationType | string | Three-digit identifier of the notification type. "060" denotes the account balance change notification. |
AccountBalance | integer | Account Balance is the total amount of all the funds for an account at any time. |
AccountCurrency | string | Three-digit ISO currency code for an account. |
AccountNumber | string | Eight-digit account number of the consumer. |
AvailableBalance | integer | Available Balance is the actual amount immediately available for withdraw, transfer and use, after any authorization hold (reserved) for an account. Consumer’s Available balance may be different than Account balance in case of any Debit holds or Credit holds for an account. |
HoldBalance | integer | Authorization hold on a debit transaction. |
CreditHoldBalance | integer | Reserved amount on a credit transaction. |
ReservedInEnvelopes | integer | Reserved balance for envelope transactions. |
SortCode | string | Six-digit number that identifies the branch of the bank where consumer holds account. |
Iban | string | Unique, 34-alphanumeric character code that identifies banks globally. IBAN consists of country code, two-check digits, and a alpha-numeric pattern that includes the domestic bank account number, branch identifier, and potential routing information. |
Bic | string | Bank Identifier Code that identifies the name, country, and branch of the bank. Used for quick, accurate and automated money transfer. |
FriendlyName | string | Friendly name of an account to identify an account easily from multiple accounts. |
DisplaySortCode | string | It is the SortCode with the display format configuration. |
CompanyID | integer | Unique identifier that indicates the company that an account belongs to. It will have value “0” when the account does not belong to any company. |
Status | string | Two-digit unique identifier that indicates the “status of the account” |
SecurityHash | string | Contains the hash of the payload values and your webhook security key, to verify the origin and integrity of the notification. |
Example of account balance change notification
{
"NotificationType" : "060",
"AccountBalance" : "123",
"AccountCurrency" : "826",
"AccountNumber" : "123456",
"AvailableBalance" : "123",
"HoldBalance" : "123",
"CreditHoldBalance" : "123",
"ReservedInEnvelopes" : "123",
"SortCode" : "623053",
"Iban" : "GB35CNFV60837000000570",
"Bic" : "CNFVGB21XXX",
"FriendlyName" : "Account Friendly Name",
"DisplaySortCode" : "623053",
"CompanyID" : "123",
"Status" : "01",
"SecurityHash" : "3c48095895ad2c673727f295be905996f8e0f88c3d4331d8f137a882936475ac"
}
Lookup values for Account status
Account status | Description |
---|---|
01 | Live (Active) |
02 | Suspended |
03 | Inactive |
04 | Closed |
05 | Frozen |
06 | Dormant |
07 | Limited |
08 | Restricted |
Validating the notification security Hash
Security Hash validation
See the respective guide for more information on calculating and verifying the notification security hash.
To compute the hash of the notification payload, concatenate the payload values in the following sequence, with your webhook security key as the final item:
<NotificationType>&<AccountBalance>&<AccountCurrency>&<AccountNumber>&<AvailableBalance>&<HoldBalance>&<CreditHoldBalance>&<ReservedInEnvelopes>&<SortCode>&<Iban>&<Bic>&<FriendlyName>&<DisplaySortCode>&<CompanyID>&<Status>&<webhook-security-key>
The example payload values above and a webhook security key of abcdefghijklmnop
will produce the following hash input:
060&123&826&123456&123&123&123&123&623053&GB35CNFV60837000000570&CNFVGB21XXX&Account Friendly Name&623053&12301&abcdefghijklmnop