Schedule Load Created Notify

This notification is triggered when a scheduled load is created successfully.

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": "SCHEDULE_LOAD_CREATED_NOTIFY",
      "notificationCreationTime": "2025-03-07T15:10:52.466Z",
      "notificationContent": {
        "notificationKey": "D8CCR7aK5HMEBKYG",
        "scheduleReference": "0UwKI0cm7w75OwIVjuJ8jWkZK",
        "sourceReference": "0UwLflRGHcqjaoPIrwqmzG0-6",
        "destinationReference": "0UwJ6lkwMyFGd9A3GGvnxqTzN",
        "currency": "USD",
        "amount": "12.45",
        "scheduleDate": "10 March 2025"
      }
    }'

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
scheduleReference	Contains a unique identifier for the scheduled load	string required
sourceReference	Contains a unique identifier for the source funding account	string required
destinationReference	Contains a unique identifier for the destination card	string required
currency	Represents the currency of the amount to be loaded onto the card, in ISO 4217 format (e.g., USD)	string required
amount	Represents the amount to be loaded onto the card	string required
scheduleDate	Represents the date in format dd MMMM yyyy when the actual load will occur	string required