Balance Notification

The BalanceNotification method enables to receive notification for the TCH 'Balance broadcast' messages

Method: InboundServiceClient:BalanceNotification

Headers

Name	Value
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
currency Conditional Mandatory	String Currency in which the transaction happens (Mandatory if eventCode is 994) Example – "USD"
availablePrefundedBalance Conditional Mandatory	String Prefunded balance available in the settlement account (Mandatory if eventCode is 993) Example – "45456861"
avalablePrefundedBalanceStatus Conditional Mandatory	String Low or high watermark threshold status of available prefunded balance (Mandatory if eventCode is 993) Example – "NORMAL"
event Mandatory	String Type of balance notification Possible values: "PREFUNDED_BALANCE_WARNING_NOTIFICATION" for event code 993 "PREFUNDED_BALANCE_BREACH_NOTIFICATION" for event code 994 "PREFUND_REQUIREMENT_CHANGE_NOTIFICATION" for event code 996 "PREFUND_BALANCE_CHANGE_NOTIFICATION" for event code 998 Example – "PREFUNDED_BALANCE_BREACH_NOTIFICATION"
eventCode Mandatory	String Code representing the event Possible values: "993" "994" "996" "998" Example – "994"
eventTime Mandatory	String Date and time of the balance notification event was created Example – "2024-05-31T08:53:15-04:00"
highWatermarkValue Conditional Mandatory	String Threshold value of the minimum prefunded balance to be maintained (Value above which the status is ‘NORMAL') (Mandatory if eventCode is 993) Example – "4454534"
lowWatermarkValue Conditional Mandatory	String Value below which balance warning is triggered (Mandatory if eventCode is 993) Example – "788431"
instructingID Conditional Mandatory	String Unique ID of the instruction that creating the balance notification (Mandatory if eventCode is 994) Example – "20151115021200201BFFF0000000001"
msgID Mandatory	String Unique message identifier to identify the pacs.008 message Example – "2024053108531598989989845QDYUGVJOST"
openingPrefundedBalanceStatus Conditional Mandatory	String Opening value of prefunded balance (Mandatory if eventCode is 993) Example – "687434"
netPosition Conditional Mandatory	String Net balance amount of the account (Mandatory if eventCode is 994) Example – "100000"
paymentAmount Conditional Mandatory	String Amount that is used for payment transaction (Mandatory if eventCode is 994) Example – "25000"
prefundedBalance Conditional Mandatory	String Prefunded balance amount that is kept as deposit in the account (Mandatory if eventCode is 994) Example – "100000000"
prefundedBalanceBreachStatus Conditional Mandatory	String Status of the prefunded balance breach (If the payment amount exceeds the prefunded balance limit, the payment is rejected) (Mandatory if eventCode is 994) Example – "PAYMENT RJCT"
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH"
referenceNumber Mandatory	String Reference number of the balance notification message Example – "2024053108531598989989845QDYUGVJOST"
residualPrefundedBalancePos Conditional Mandatory	String Remaining prefunded balance amount position (Mandatory if eventCode is 994) Example – "10"
routingNumber Mandatory	String Routing number of the bank or financial institution Example – "011001276"
uuid Mandatory	String Unique ID present in the message Example – "52ac61c7-54ee-4c58-ab69-20fbeba82912"

Request Body (Applicable only for TCH)

EventCode:993
{
  "availablePrefundedBalance": "45456861",
  "avalablePrefundedBalanceStatus": "NORMAL",
  "event": "PREFUNDED_BALANCE_WARNING_NOTIFICATION",
  "eventCode": "993",
  "eventTime": "2024-06-06T03:50:32-04:00",
  "highWatermarkValue": "4454534",
  "lowWatermarkValue": "788431",
  "msgID": "20240606035032123456789T1KD4EGSZMED",
  "openingPrefundedBalanceStatus": "687434",
  "processor": "TCH",
  "referenceNumber": "20240606035032123456789T1KD4EGSZMED",
  "routingNumber": "011001331",
  "uuid": "7ca922ab-3384-4ddc-8c06-c3228c999bb8"
}

EventCode:994
{
  "currency": "USD",
  "event": "PREFUNDED_BALANCE_BREACH_NOTIFICATION",
  "eventCode": "994",
  "eventTime": "2024-05-31T08:53:15-04:00",
  "instructingID": "20151115021200201BFFF0000000001",
  "msgID": "2024053108531598989989845QDYUGVJOST",
  "netPosition": "100000",
  "paymentAmount": "25000",
  "prefundedBalance": "100000000",
  "prefundedBalanceBreachStatus": "PAYMENT RJCT",
  "processor": "TCH",
  "referenceNumber": "2024053108531598989989845QDYUGVJOST",
  "residualPrefundedBalancePos": "10",
  "routingNumber": "011001276",
  "uuid": "52ac61c7-54ee-4c58-ab69-20fbeba82912"
}

EventCode:996
{
  "event": "PREFUND_REQUIREMENT_CHANGE_NOTIFICATION",
  "eventCode": "996",
  "eventTime": "2024-06-06T03:53:00-04:00",
  "msgID": "20240606035300123456789T1IT4EHQBOGD",
  "processor": "TCH",
  "referenceNumber": "20240606035300123456789T1IT4EHQBOGD",
  "routingNumber": "011001331",
  "uuid": "f8a62c4d-ddf1-4eba-aeb8-acd187b6955c"
}

EventCode:998
{
  "event": "PREFUND_BALANCE_CHANGE_NOTIFICATION",
  "eventCode": "998",
  "eventTime": "2024-06-06T04:02:42-04:00",
  "msgID": "20240606040242123456789T1MDYUGSRNSD",
  "processor": "TCH",
  "referenceNumber": "20240606040242123456789T1MDYUGSRNSD",
  "routingNumber": "011001331",
  "uuid": "d0ff6b2d-33f1-4518-814f-92ecd8cb6578"
}

Response

Response Parameters

Parameter	Description
routingNumber	String Routing number of the bank or financial institution Example – "011001276"
status	String Status of the request received for balance notification Example – "Accepted"

Response Body (Applicable only for TCH)

{
  "routingNumber": "011001276",
  "status": "Accepted"
}