GET
/
Notification
/
{nId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Notification/{nId} \
  --header 'requestToken: <api-key>'
{
  "notificationId": 148417,
  "ownerName": "The Pilgrim Planner",
  "createdAt": "2024-02-21T09:16:31.17",
  "lastUpdated": "2024-02-21T09:16:31.17",
  "ownerId": 236,
  "ownerType": 0,
  "method": "report-email",
  "frequency": "weekly",
  "target": "admin@business.com",
  "source": null,
  "status": 1,
  "content": {
    "eventType": null,
    "transactionId": null,
    "fileFormat": "csv",
    "reportName": "Returned",
    "timeZone": null,
    "webHeaderParameters": null,
    "internalData": null
  }
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
nId
string
required

Notification ID.

Response

200
application/json
Success
​
ownerId
string | null

ID for the paypoint or organization that owns the notification.

Example:

"123"

​
ownerType
enum<integer>

Entity owner type. Accepted values:

  • 0: Organization/partner
  • 2: Paypoint
Available options:
0,
2
Example:

0

​
method
enum<string>

Method to use to send the notification to the target.

Available options:
email,
sms,
web,
report-email,
report-web
​
frequency
enum<string> | 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
Available options:
one-time,
daily,
weekly,
biweekly,
monthly,
quarterly,
semiannually,
annually,
untilcancelled
​
target
string | 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.

​
source
string | null

Custom descriptor of source of notification.

Maximum length: 100
Example:

"api"

​
status
enum<integer> | null

Status of notification:

  • 0: Inactive
  • 1: Active
Available options:
0,
1
​
content
object

Notification content.

​
notificationId
integer

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

Example:

1414

​
ownerName
string | null

Name of entity owner of notification.

Example:

"The Pilgrim Planner"

​
createdAt
string

Timestamp of when notification was created.

Example:

"2022-07-01 15:00:01"

​
lastUpdated
string | null

Timestamp of when notification was last updated.

Example:

"2022-07-01 15:00:01"

Was this page helpful?