Purpose: To configure an Integration Sources Notification URL to accept our FrontStream transaction notification status payloads as transactions are updated or newly processed for example recurring contracts .
Responses:
200 (Success): Returns saved notification config.
400 (Bad Request): Throws exception if the notification config was not saved.
Example PUT request
PUT /api/notificationConfig
{
"NotificationConfigs": [
{
"NotificationConfigurationTypeId": "1", // This should always be equal to "1"
"NotificationProtocolTypeId": "1", // Use only "1" (WEB) for now. "2" (Email) not yet supported
"NotificationUrl": "string", // Url to post our notification to. Example: https://{yourenvironment.yourdomain}.com/api/yourNotification endpoint
"Retries": 0, // number of retries to try again failed notifications - currently retries 10 times by default or set to 0
"AccessToken": "string", // optional - if access token needed to hit your notification url
"IsDeleted": false // set to true if you wish to soft-delete configuration, otherwise set to false
}
]
}
Step 2. Test your Notifications URL can retrieve a transactions notification payload by using our Payment API POST /api/notificationTest .
Purpose: To test a configured Integration Sources Notification URL can accept our FrontStream transaction notification status payloads as transactions are updated or newly processed for example recurring contracts .
Parameters:
Url: Integration Source endpoint to post notification payload to. Example: https://{yourenvironment.yourdomain}.com/api/yourNotification endpoint..
Payload: test payload posting over to Url
AccessToken: optional if access token is required to hit notification url.
Responses:
200 (Success):
400 (Bad Request): Throws exception if unable to send notification.
Example POST notificationTest request
Step 3. Optional: If you would like to retrieve previous notifications by Payment identifier please use our Payment API GET /api/notifications.
