API referencePay Ops endpointsNotifications

Get notification

Retrieves a single notification or autogenerated report’s details.

Path parameters

nIdstringRequired

Notification ID.

Headers

requestTokenstringRequired

Response

Success

contentobjectOptional

Notification content.

createdAtdatetimeOptional

Timestamp of when notification was created.

frequencyenumOptional

Frequency for notification. For notifications using the email ,sms, or web method, the allowed values are:

  • untilcancelled
  • one-time

For notifications using the report-email or report-web method, the allowed values are:

  • one-time
  • daily
  • weekly
  • biweekly
  • monthly
  • quarterly
  • semiannually
  • annually
lastUpdateddatetimeOptional

Timestamp of when notification was last updated.

methodenumOptional

Method to use to send the notification to the target.

Allowed values:
notificationIdlongOptional

The notification’s Payabli identifier. This is the ID used to manage the notifcation.

ownerIdstringOptional

ID for the paypoint or organization that owns the notification.

ownerNamestringOptional

Name of entity owner of notification.

ownerTypeintegerOptional

Entity owner type. Accepted values:

  • 0: Organization/partner
  • 2: Paypoint
sourcestringOptional<=100 characters

Custom descriptor of source of notification.

statusintegerOptional

Status of notification:

  • 0: Inactive
  • 1: Active
targetstringOptional

Specify the notification target.

For method=email the expected value is a list of email addresses separated by semicolon.

For method=sms the expected value is a list of phone numbers separated by semicolon.

For method=web. the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.

Errors