Get Notifications

Info

Draft Documentation - This section is currently under review and may be subject to changes.

This method retrieves all notifications for a player, with an optional filter for unread notifications only. Notifications are retained for 90 days and returned in descending order (newest first).

Request (GET)

/gateway/notifications/{version}/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use (e.g., “1.0”).
brand_id path int true The ID of the casino brand.
only_unread query boolean false If true, returns only unread notifications. Defaults to false (all).

Headers:

Name Type Required Description
x-auth-token string true Player authentication token.

Response

Status 200

{
  "status": "Success",
  "data": {
    "notifications": [
      {
        "message_id": "a7f8c934-1b2d-4e5f-9c8a-7d6e5f4a3b2c",
        "brand_id": 1001,
        "player_id": 12345,
        "event": "bonus_granted",
        "event_details": {
          "bonus_amount": 100,
          "bonus_type": "welcome",
          "currency": "USD"
        },
        "is_read": false,
        "time": "2025-10-22 14:30:45"
      },
      {
        "message_id": "b8e9d045-2c3e-5f6g-0d9b-8e7f6g5b4c3d",
        "brand_id": 1001,
        "player_id": 12345,
        "event": "promotion_available",
        "event_details": {
          "promo_id": "PROMO123",
          "expires_at": "2025-11-15",
          "conditions": {
            "min_bet": 100,
            "multiplier": 3
          }
        },
        "is_read": true,
        "time": "2025-10-21 10:15:30"
      }
    ],
    "total_count": 2
  }
}

Response Parameters:

Name Type Description
notifications array Array of notification objects.
notifications.message_id string Unique notification identifier (UUID).
notifications.brand_id int Brand identifier.
notifications.player_id int Player identifier.
notifications.event string Event type (e.g., “bonus_granted”, “promotion_available”).
notifications.event_details object Event-specific data (flexible JSON object).
notifications.is_read boolean Whether the notification has been read.
notifications.time string Notification timestamp in format “YYYY-MM-DD HH:MM:SS”.
total_count int Total number of notifications returned.

Example: Get Unread Notifications Only

Request:

GET /notifications/1.0/1001/12345?only_unread=true
x-auth-token: e74af034-a346-4d5c-be97-f7ed83f373a7

Response:

{
  "status": "Success",
  "data": {
    "notifications": [
      {
        "message_id": "a7f8c934-1b2d-4e5f-9c8a-7d6e5f4a3b2c",
        "brand_id": 1001,
        "player_id": 12345,
        "event": "bonus_granted",
        "event_details": {
          "bonus_amount": 100,
          "bonus_type": "welcome"
        },
        "is_read": false,
        "time": "2025-10-22 14:30:45"
      }
    ],
    "total_count": 1
  }
}

Status 401

{
  "status": "error",
  "message": "Unauthorized - Invalid or missing authentication token"
}

Status 500

{
  "status": "error",
  "message": "Internal server error"
}

Notes

  • Notifications are automatically deleted after 90 days.
  • Results are ordered by time in descending order (newest first).
  • The event_details field is flexible and can contain any event-specific data as a JSON object.
  • Common event types include: bonus_granted, promotion_available, deposit_success, kyc_approved, account_update.