API referencePay Ops endpointsNotifications

Create notification

Create a new notification or autogenerated report.

Headers

requestTokenstringRequired

Request

This endpoint expects an object.
NotificationobjectRequired

Create a standard webhook, email, or SMS notification.

OR
ReportobjectRequired

Create an auto-generated report.

Response

Success

isSuccessbooleanOptional

If isSuccess = true, responseData contains the notification identifier.

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

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

responseDatainteger or stringOptional

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

responseTextstringOptional

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

Errors