How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payabli Notification API

The Notification API from Payabli — 3 operation(s) for notification.

Payabli Notification API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.

5 operations 3 paths 39 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Payabli Notification API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as requestToken (APIKeyAuth).

  • BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
  • APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Notification 5
POST
/Notification
Add notification
AddNotification 1 param body → 200400401500503
GET
/Notification/{nId}
Get notification
GetNotification 2 params → 200400401500503
PUT
/Notification/{nId}
Update notification
UpdateNotification 2 params body → 200400401500503
DELETE
/Notification/{nId}
Delete notification
DeleteNotification 2 params → 200400401500503
GET
/Export/notificationReport/{Id}
Export generated report by ID
GetReportFile 2 params → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are NotificationQueryRecord (12 properties), NotificationReportRequestContent (7 properties), NotificationContent (7 properties), NotificationReportRequest (7 properties). Each schema is shown below with its type and property counts.

NotificationReportRequestFrequency
string
PayabliApiResponseNotifications
object
5 properties 1 required
File
object
A file containing the response data, in the format specified in the request.
PayabliApiResponseNotificationsResponseData
When the request was successful, this contains the notification ID, or nID used to manage the notification.
Frequencynotification
string
Frequency for notifications.
NotificationContentReportName
string
The kind of report to generate. For [automated reports](/developers/developer-guides/notifications-and-webhooks-overviewautomated-reports) only.
NotificationStandardRequestContentEventType
string
The notification's event name.
NotificationContentEventType
string
The notification's event name.
NotificationReportRequestContentReportName
string
The kind of report to generate.
NotificationReportRequestContentFileFormat
string
Indicate the format of report file to be generated by the engine.
UpdateNotificationRequest
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties 2 required
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
NotificationReportRequestContent
object
7 properties
Ownertype
integer
Entity owner type. Accepted values: - 0: Organization/partner - 2: Paypoint
NotificationStandardRequest
object
Information about the standard notification configuration (email, SMS, web).
7 properties 4 required
NotificationReportRequestMethod
string
Automated reporting lets you gather critical reports without manually filtering and exporting the data. Get automated daily, weekly, and monthly reports for da…
Target
string
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…
NotificationContent
object
7 properties
Source
string
Custom identifier to indicate the transaction or request source.
NotificationQueryRecord
object
12 properties
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
Methodnotification
string
Method to use to send the notification to the target.
NotificationId
integer
The notification's Payabli identifier. This is the ID used to manage the notification.
LastModified
string
Timestamp of when record was last updated, in UTC.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
NotificationContentFileFormat
string
Indicate the format of report file to be generated by the engine. Used for method = report-email and report-web.
NotificationStandardRequestMethod
string
Get near-instant notifications via email, SMS, or webhooks for important events like new payment disputes, merchant activations, fraud alerts, approved transac…
KeyValueDuo
object
2 properties
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
NotificationStandardRequestContent
object
4 properties
AddNotificationRequest
NotificationReportRequest
object
Information about the report notification configuration (report-email, report-web).
7 properties 5 required
NotificationStandardRequestFrequency
string
Ownerid
integer
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…
CreatedAt
string
Timestamp of when record was created, in UTC.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
Statusnotification
integer
Status of notification: - 0: Inactive - 1: Active

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payabli-notification-api-openapi.yml Raw ↑

Other APIs Payabli publishes across the network.

Payabli Bill API
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Where this information came from

This is an independent, third-party profile of Payabli Notification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.