APIPay Ops endpointsNotifications

Get notification

Retrieves a single notification or autogenerated report's details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

nIdstringRequired
Notification ID.

Response

Success
contentobject or null
Notification content.
createdAtdatetime or null
Timestamp of when notification was created.
frequencyenum or null
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 or null
Timestamp of when notification was last updated.
methodenum or null
Method to use to send the notification to the target.
Allowed values:
notificationIdlong or null
The notification's Payabli identifier. This is the ID used to manage the notification.
ownerIdstring or null
ID for the paypoint or organization that owns the notification.
ownerNamestring or null
Name of entity owner of notification.
ownerTypeinteger or null
Entity owner type. Accepted values: - `0`: Organization/partner - `2`: Paypoint
sourcestring or null<=100 characters
Custom descriptor of source of notification.
statusinteger or null

Status of notification:

  • 0: Inactive
  • 1: Active
targetstring or null
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