Skip to main content
Use this endpoint to retrieve the current notification and platform preferences configured for your Shogun account. The response includes settings such as balance monitoring thresholds, activity email subscriptions, and system update notifications. If no preferences have been saved yet, default subscriptions are automatically created for your account.

​
Endpoint

POST /api/v1/notification/web/get_preferences

​
Authentication

All requests must include a valid Dashboard Bearer token in the Authorization header.
HeaderTypeRequiredDescription
AuthorizationstringYesBearer <token> — obtain from Login
Content-TypestringYesapplication/json

​
Request Body

This endpoint requires no request body.

​
Response

A successful response returns your account’s current preferences object.
FieldTypeDescription
balance_monitoringobjectBalance monitoring configuration for your account
balance_monitoring.enabledbooleanWhether balance monitoring alerts are active
balance_monitoring.thresholdstringBalance threshold that triggers an alert
balance_monitoring.recipientsarray of stringsEmail addresses that receive balance alerts
activity_emailsobjectPer-event email notification toggles
system_updatesobjectSystem and maintenance notification toggles

​
Success

{
  "status": true,
  "response_code": "00",
  "message": "Success",
  "data": {
    "balance_monitoring": {
      "enabled": true,
      "threshold": "50000.00",
      "recipients": [
        "ops@yourcompany.com",
        "cfo@yourcompany.com"
      ]
    },
    "activity_emails": {
      "inflow.received": true,
      "outflow.completed": true,
      "transfer.failed": true
    },
    "system_updates": {
      "system.product_update": true,
      "system.maintenance": true
    }
  }
}

​
Example

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/notification/web/get_preferences \
  --header 'Authorization: Bearer <your_dashboard_token>' \
  --header 'Content-Type: application/json'