Notification

Get notification

Retrieves a single notification or autogenerated report's details.

get/Notification/{nId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Notification/{nId}
  • Auth: HTTP bearer

Path parameters

nIdstring required

Notification ID.

Response

Success

createdAtstring date-time

Timestamp of when record was created, in UTC.

frequency'one-time' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'untilcancelled'

Frequency for notifications.

lastUpdatedstring date-time

Timestamp of when record was last updated, in UTC.

method'email' | 'sms' | 'web' | 'report-email' | 'report-web'

Method to use to send the notification to the target.

notificationIdinteger

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

Custom identifier to indicate the transaction or request source.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.