APIPay Ops endpointsNotifications

Create notification

View as MarkdownOpen in Claude

Create a new notification or auto-generated report.

Authentication

requestTokenstring
API Key authentication via header

Request

This endpoint expects an object.
NotificationobjectRequired

Information about the standard notification configuration (email, SMS, web).

OR
ReportobjectRequired

Information about the report notification configuration (report-email, report-web).

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

If isSuccess = true, responseData contains the notification identifier. If isSuccess = false, responseData contains the reason for the error.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDatainteger or string

When the request was successful, this contains the notification ID, or nID used to manage the notification.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error