APIPay Ops endpointsNotifications

Get notification

View as MarkdownOpen in Claude
Retrieves a single notification or autogenerated report's details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

nIdstringRequired
Notification ID.

Response

Success
contentobject
Notification content.
createdAtdatetime
Timestamp of when notification was created.
frequencyenum

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
lastUpdateddatetime
Timestamp of when notification was last updated.
methodenum
Method to use to send the notification to the target.
Allowed values:
notificationIdlong
The notification's Payabli identifier. This is the ID used to manage the notification.
ownerIdinteger

ID for the paypoint or organization that owns the notification.

If the ownerType field is 0, this field is the same as the orgId for the organization that owns this notification.

If the ownerType field is 2, this field is the same as the paypointId for the paypoint that owns this notification.

ownerNamestring
Name of entity owner of notification.
ownerTypeinteger

Entity owner type. Accepted values:

  • 0: Organization/partner
  • 2: Paypoint
sourcestring<=100 characters
Custom descriptor of source of notification.
statusinteger

Status of notification:

  • 0: Inactive
  • 1: Active
targetstring

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

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