APIPay Ops endpointsNotification Logs

Search notification logs

View as MarkdownOpen in Claude
Search notification logs with filtering and pagination. - Start date and end date cannot be more than 30 days apart - Either `orgId` or `paypointId` must be provided This endpoint requires the `notifications_create` OR `notifications_read` permission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Query parameters

PageSizeintegerOptional
Number of records on each response page.
PageintegerOptional
The page number to retrieve. Defaults to 1 if not provided.

Request

This endpoint expects an object.
startDatedatetimeRequired

The start date for the search. Can’t be more than 30 days before endDate.

endDatedatetimeRequired

The end date for the search. Can’t be more than 30 days after startDate.

notificationEventstringOptional

The event to filter by, such as approvedpayment. Case-insensitive.

succeededbooleanOptional

Filter by delivery outcome. Set to false to return only failed notifications.

orgIdlongOptional

The ID of the organization to filter by. Either orgId or paypointId is required.

paypointIdlongOptional

The ID of the paypoint to filter by. Either orgId or paypointId is required.

Response

Success
organizationFavIconstring
The URL of the organization's browser tab icon.
notificationTypeinteger

The notification’s delivery method — 1 (Email), 2 (SMS), or 3 (Webhook).

organizationNamestring
The name of the organization the notification belongs to.
paypointNamestring

The name of the paypoint the notification is related to. Empty for organization-level notifications.

requestIdstring
The identifier for the delivery request.
idstringformat: "uuid"
The unique identifier for the notification.
orgIdlong or null
The ID of the organization the notification belongs to.
paypointIdlong or null

The ID of the paypoint the notification is related to. Null for organization-level notifications.

notificationEventstring or null

The event that triggered the notification, such as approvedpayment.

targetstring or null
The target the notification was delivered to, such as a webhook URL, email address, or phone number.
responseStatusCodeinteger

The HTTP status code the target returned, such as 200. Returns 0 when the target sent no response.

responseStatusstring

The delivery status message, such as OK when the notification succeeded, Dropped when it failed, or No response received from server. when the target sent no response.

successboolean
Indicates whether the notification was delivered successfully.
jobDatastring or null
The body of the notification.
createdDatedatetime
The date and time when the notification was created.
successDatedatetime or null
The date and time when the notification was delivered successfully. Null if it hasn't succeeded.
lastFailedDatedatetime or null
The date and time when the notification last failed. Null if it hasn't failed.
isInProgressboolean
Indicates whether the notification is currently being sent.

Errors

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