Notifications

MarkUserPushNotificationsAsRead marks a list of push notifications as read for the authenticated user

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/notifications/v1/me/notifications/push/read

Accepts up to 200 notification_ids per call. Only affects notifications owned by the caller

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Body

application/json

notificationIdsstring[]Required

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/notifications/v1/me/notifications/push/read

HTTPcURLJavaScriptPython

POST /notifications/v1/me/notifications/push/read HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "notificationIds": [
    "text"
  ]
}

{
  "notifications": [
    {
      "channel": "text",
      "createdAt": "2026-08-10T20:09:37.394Z",
      "failReason": "text",
      "id": "text",
      "notificationName": "text",
      "payload": "text",
      "readAt": "2026-08-10T20:09:37.394Z",
      "status": "text",
      "updatedAt": "2026-08-10T20:09:37.394Z",
      "userId": "text"
    }
  ]
}

GetNotificationsByUserId returns all notification on the system associated to the provided user

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/notifications/v1/users/{userId}/notifications

Includes every channel and status, not just push. For a single user's unread push notifications use GetUserPushNotifications instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Query parameters

pageinteger · int32Optional

page is an optional query parameter to set the page number

limitinteger · int32Optional

limit is an optional query parameter to set the max amount of results per page

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/notifications/v1/users/{userId}/notifications

HTTPcURLJavaScriptPython

GET /notifications/v1/users/{userId}/notifications HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "notifications": [
    {
      "channel": "text",
      "createdAt": "2026-08-10T20:09:37.394Z",
      "failReason": "text",
      "id": "text",
      "notificationName": "text",
      "payload": "text",
      "readAt": "2026-08-10T20:09:37.394Z",
      "status": "text",
      "updatedAt": "2026-08-10T20:09:37.394Z",
      "userId": "text"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "limit": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

GetUserPushNotifications returns all unread push notifications for the authenticated user

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/notifications/v1/users/{userId}/notifications/push

Push channel only and unread only. Mark them read via MarkUserPushNotificationsAsRead once shown to the user

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/notifications/v1/users/{userId}/notifications/push

HTTPcURLJavaScriptPython

GET /notifications/v1/users/{userId}/notifications/push HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "notifications": [
    {
      "channel": "text",
      "createdAt": "2026-08-10T20:09:37.394Z",
      "failReason": "text",
      "id": "text",
      "notificationName": "text",
      "payload": "text",
      "readAt": "2026-08-10T20:09:37.394Z",
      "status": "text",
      "updatedAt": "2026-08-10T20:09:37.394Z",
      "userId": "text"
    }
  ]
}