Integrating Casino Backoffice Platform with Chatform
/api/player/details
Description: Retrieves the full profile of a player, including their category (e.g., VIP, regular).
Response Fields:
player_id
: Unique identifier for the playername
: Player’s nameemail
: Player’s emailcategory/tier
: Player category (e.g., VIP, regular)Responsible gaming deposit limits
: RG deposit limits of a player,Responsible gaming deposit limits
: RG loss limits of a player,Active withdrawal
: Is there an active pending withdrawal,/api/player/authenticate
Description: Authenticates a player using provided credentials.
Response Fields:
status
: Authentication status (success/failure)player_id
: Unique identifier for the player (if authenticated)/api/player/transactions/summary
Description: Retrieves a summary of the player’s transactions, including deposits, withdrawals, and bonuses.
Response Fields:
total_deposits
: Total amount deposited by the playertotal_withdrawals
: Total amount withdrawn by the playertotal_bonuses
: Total amount of bonuses received by the player/api/player/transactions
Description: Provides detailed information about all transactions made by the player.
Response Fields:
transaction_id
: Unique identifier for the transactiontimestamp
: Date and time of the transactiontype
: Type of transaction (deposit, bet, withdrawal, bonus)amount
: Amount of the transaction/api/player/bets
Description: Retrieves details of all bets placed by the player, classified by casino or sports.
Response Fields:
bet_id
: Unique identifier for the bettimestamp
: Date and time of the betcategory
: Category of the bet (casino/sports)amount
: Amount wagered/api/player/bonuses
Description: Provides detailed information about the player’s bonuses, including real and bonus balances.
Response Fields:
real_balance
: Current real money balancebonus_balance
: Current bonus balancebonuses
: List of bonuses received/api/player/deposits
Description: Retrieves detailed information about the player’s deposits.
Response Fields:
deposit_id
: Unique identifier for the deposittimestamp
: Date and time of the depositamount
: Amount deposited/api/player/kyc-details
Description: Retrieves the Know Your Customer (KYC) details for a specific player, including verification status and required documents.
Response Fields:
player_id
: Unique identifier for the playerkyc_status
: KYC verification status (e.g., verified, pending, failed)documents
: List of required documents and their statuses
document_type
: Type of document (e.g., ID, proof of address)status
: Status of the document (e.g., submitted, verified, rejected)submitted_date
: Date the document was submitted/api/player/rg-closed
Description: Returns whether the player has a Responsible Gaming (RG) closure, indicating if the player is restricted from playing due to RG policies.
Response Fields:
player_id
: Unique identifier for the playerrg_closed
: Boolean value indicating RG closure status (true or false)/api/player/eligible-bonuses
Description: Retrieves a list of bonuses that the specified player is eligible for. Based on the value of the criteria_type
parameter as LOGIN
, this API returns all eligible bonuses for the player.
Request Parameters:
player_id
: Unique identifier for the playercriteria_type
: Criteria for retrieving bonuses (e.g., LOGIN
)player_id
: Unique identifier for the playercriteria_type
: Criteria used for retrieving bonusesbonuses
: List of eligible bonuses
bonus_id
: Unique identifier for the bonusbonus_name
: Name of the bonusbonus_amount
: Amount of the bonusexpiry_date
: Expiry date of the bonus