Online Player Status

This method returns data about an online player. use gateway.[msdomain]

Request (GET)

/gateway/online-player/{version}/player/{brand_id}/online/status

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player login session.

Response

Status 200

{
  "marketingSegmentation": "10",
  "tag_status": 100,
  "deposit_count": 1,
  "vip_level": "Bronze",
  "average_deposit": 44,
  "billboard": "",
  "segmentation_id": 1,
  "maxBalance": 93604,
  "UT": 1,
  "decline": "0",
  "VIP_segment": 1,
  "total_balance": 936.04,
  "pending_withdrawal": 44,
  "total_withdrawals": 0,
  "last_bet": "2022-01-01 00:00:01",
  "last_deposit": "2022-01-01 00:00:01",
  "last_deposit_amount": 44,
  "rounds_since_login": 0,
  "balance_since_login": 0,
  "playerIdLink": "https://cbo2.aaa.com/players/123456789",
  "bonusOptOut": 0,
  "real_balance": 906.04,
  "freeTraffic": false,
  "depositsAmount": 44,
  "chat_opt_out": false,
  "bonusBalance": 30.0,
  "maxWin": 12.0,
  "wageringBalance": 1540.12,
  "wageringComplete": ""
}

Status 303, in case of reality check enabled for player and time has passed

{
  "currency": "EUR",
  "profit": 10,
  "total_bets": 200,
  "total_wins": 300,
  "total_lossed": 0,
  "restart_period": "15_min",
  "time_played": "1 hour 15 minutes",
  "min": "15",
  "h": "1"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail.
{
  "result": "INCOMPLETE_REGISTRATION"
}

401 Response

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
marketingSegmentation player marketing segmentation.
vip_level player vip level.
VIP_segment player vip segmentation.
total_balance current player balance (including bonuses).
lastBet player last time of wager.
lastDeposit player last time of deposit.
realBalance player real money in balance
bonusBalance player bonus money in balance
wageringBalance player remaining wagering money
wageringComplete indication if player has recently had wagering completed event (0/1)
maxWin wagering complete max win of bonuses which had wagering completion
wageringCompleteInfoPath path for wagering complete event details, need to add gateway domain for request - gateway.[msdomain], format will be: ‘/gateway/bonus/{version}/wagering-complete/{brand_id}/{player_id}/{unique_ref_id}’
is_missing_player_details indication if player has missing details, need to ask to fill details before deposit call