API referencePay Ops endpointsNotifications

Create notification

Create a new notification or autogenerated report.

Authentication

requestTokenstring
API Key authentication via header

Request

This endpoint expects an object.
Notification Standard RequestobjectRequired
OR
Notification Report RequestobjectRequired

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

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