Card Balance Limit Notify

This notification is triggered when a card's Available Balance reaches the predefined threshold (where applicable)

https://<customerHost:Port>/handlenotification

Header

Field	Description
Content-Type	application/json

Request example

curl --location --request POST 'https://<customerHost:Port>/handlenotification' \
-H 'Content-Type: application/json' \
-d '{
      "notificationType": "CARD_BALANCE_LIMIT_NOTIFY",
      "notificationCreationTime": "2025-03-07T15:10:52.425Z",
      "notificationContent": {
        "notificationKey": "D8CCR7aK5HMEBKYG",
        "cardReference": "0UwIg396z_EfegG1SeLQJLi1I",
        "limitType": "LOWER_LIMIT",
        "availableBalanceCurrency": "USD",
        "availableBalanceAmount": "12.43"
      }
    }'

Request Body

Field	Description	Type
notificationType	Specifies the type of notification being sent.	string required
notificationCreationTime	Specifies the creation date and time for the notification. The date format conforms to ISO 8601	string required
notificationContent	Specifies the notification content	object required

Properties of notificationContent

Field	Description	Type
notificationKey	Represents a unique identifier for Nium that confirms the API method call is genuine	string required
cardReference	Represents a unique identifier for the virtual card	string required
limitType	Represents the threshold type that was exceeded	string required
availableBalanceCurrency	Represents the virtual card's currency in ISO 4217 format (e.g., USD)	string required
availableBalanceAmount	Contains the amount by which the lower or upper limit was exceeded. For example, if the upper limit is 500 and the card has 750, this value would be 250.	string required