Comp Points

Comp Points Endpoints

This section will display all available endpoints to get comp points data.

Subsections of Comp Points

Player Comp Points

This method retrieves a players balance of comp points.

Comp points are awarded to a player with each round. When the player accumulates a minimum number of comp points, they can convert their comp points to money. use gateway.[msdomain]

Request (GET)

/gateway/financials/compoints/{version}/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int 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 path string true Player login session.

Response

Status 200

{
  "compoints": 10,
  "conversionRate": 100
}

Status 400

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

Status 401

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

Status 404

{
  "errMsg": "Player getPlayerCompoints Details not found"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
compoints current comp points balance for player.
conversionRate conversion rate by player segmentation for comp points.

Request (PUT)

/gateway/financials/compoints/{version}/{brand_id}

Parameters:

{
  "conversionAmount": 0
}
Name In Type Required Description
version path string true The API version to use.
brand_id path int 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 path string true Player login session.
conversionAmount path int true amount to redeem, will be added to player balance (conversionAmount/ conversionRate), division must return a whole number.

Response

Status 200

{
  "exchangedCompoints": 10,
  "exchangedCash": 1
}

Status 400

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

Status 401

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

Status 404

{
  "errMsg": "exchangePlayerCompoints Details not found"
}

Status 422

{
  "result": {
    "field": "compoints_conversion",
    "errorCode": "conversion_value_required"
  }
}

Status 500

{
  "errMsg": "update PlayerCompoints not succeeded"
}

Response Parameters:

Name Description
exchangedCompoints amount exchanged.
exchangedCash amount redeemed to player account.