APIPay Ops endpointsNotification Logs

Search notification logs

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.

Headers

requestTokenstringRequired

Query parameters

PageSizeintegerOptional
Number of records on each response page.
SkipintegerOptional
The number of records to skip before starting to collect the result set.

Request

This endpoint expects an object.
startDatedatetimeRequired
The start date for the search.
endDatedatetimeRequired
The end date for the search.
notificationEventstringOptional
The type of notification event to filter by.
succeededbooleanOptional
Indicates whether the notification was successful.
orgIdlongOptional
The ID of the organization to filter by.
paypointIdlongOptional
The ID of the paypoint to filter by.

Response

This endpoint returns a list of objects.
idUUID
The unique identifier for the notification.
orgIdlong or null
The ID of the organization that the notification belongs to.
paypointIdlong or null
The ID of the paypoint that the notification is related to.
notificationEventstring or null
The event that triggered the notification.
targetstring or null
The target URL for the notification.
responseStatusstring or null
The HTTP response status of the notification.
successboolean
Indicates whether the notification was successful.
jobDatastring or null
Contains 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 successfully delivered.
lastFailedDatedatetime or null
The date and time when the notification last failed.
isInProgressboolean
Indicates whether the notification is currently in progress.

Errors