Bank file notification
Solaris API service notifies the client about the bank file process.
Bank file notification parameters
Parameters | Type | Description |
---|---|---|
NotificationType | string | Three-digit identifier of the notification type. "050" denotes the Bank file notification. |
AccountNumber | string | Eight-digit account number of the consumer. |
SortCode | string | Six-digit number that identifies the branch of the bank where consumer holds the account. |
WithdrawRequestNumber | string | Unique identifier of the withdrawal request number. |
ReferenceNumber | string | Reference number used as any kind of reference. |
Status | string | Two-digit unique identifier of the status of the file process before the status is changed. |
ErrorMessage | string | It is given any kind of transaction error messages. |
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 Bank file notification
{
"NotificationType": "050",
"AccountNumber": "00118318",
"SortCode": "608370",
"WithdrawRequestNumber": "270219",
"ReferenceNumber": "",
"Status": "16",
"ErrorMessage": "",
"SecurityHash": "df25e1be2fcba598cbf375c1a7661122"
}
Lookup values for file process status
The table shows lookup values for bank file process status codes, e.g. value "16" denotes that a file is "SentOut".
File Process Status | Description |
---|---|
00 | None |
01 | Pending |
02 | Processed |
03 | Notified |
04 | Notification Not Required |
05 | Cancelled |
06 | ToBeCharged |
07 | ToBeProcess |
08 | GreyListUser |
09 | Requested |
10 | Unable to notify |
11 | InProgress |
12 | Diarised |
13 | PartiallyAccepted |
14 | OnHold |
15 | Rejected |
16 | SentOut |
17 | Settled |
18 | Settlement Reversal |
19 | Accepted |
20 | HighPriority |
21 | Directly Returned |
22 | Investigation |
23 | AccountDisabled |
24 | InsufficientFunds |
25 | InvalidAccount |
26 | InvalidCurrency |
27 | DebitPaymentDisabled |
28 | Reversed |
29 | Expired |
30 | Pending To close |
31 | ToBeClose |
32 | Closed |
33 | CC_Cash_Manager_Trade |
34 | CC_Funds_Arrived |
35 | CC_Trade_Settled |
36 | CC_Trade_Closed |
37 | TransactionHeld |
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>&<AccountNumber>&<SortCode>&<WithdrawRequestNumber>&<ReferenceNumber>&<Status>&<ErrorMessage>&<webhook-security-key>
The payload values above and example webhook security key of abcdefghijklmnop
, will produce the following hash input:
050&00118318&608370&270219&&16&&abcdefghijklmnop