This API request debits a currency amount from a player’s balance. This is triggered every time a player plays a game. The response would contain information and details of any debited amounts.
Debit() Request
Type | Input |
---|---|
HTTP Method | POST |
API URL | https://<API_BASE_URL>/debit |
Headers | "Content-Type": "application/json" |
POST Parameters | json object e.g.: { |
Parameters | Type | Description |
---|---|---|
token | String | Unique string assigned to each player (session ID) |
account_id | String | Account ID of the player |
amount | Integer | Amount to be debited from player’s wallet. Amount will be sent in cents (amount * 100) |
amount_type | String | Indicate type of amount type. It can be real / promo_freespin. |
currency | String | Currency of the player |
game_id | Integer | Unique ID of the game |
transaction_id | String | Unique id of the transaction |
round_id | Bigint unsigned | Round ID of each play / spin |
game_type | String | Type of the game. slots / table_games / scratch_cards / bingo |
game_name | String | Name of the game |
note | String | Extra information about the debit request |
bonus_id | String | Provider will send the bonus / campaign ID which is related to the promotional freespins. It will be null when it is in real mode. |
Debit() Response + Example
{
"status": 0,
"account_id": "123123",
"country": "US",
"token": "3c2ef39d02581e2db3ddf6c713e83e05",
"balance": 12345,
"currency": "USD",
"transaction_id": "205354854449856",
"bonus_amount": "10"
}
Object/Key in Response Object | Type | Description |
---|---|---|
status | Integer | Response status |
account_id | String | Account ID of the player. |
country | String | Country of the player |
token | String | Unique string assigned to each player (session ID). |
balance | Integer | Balance of the player. Balance should be in cents (balance* 100) |
currency | String | Currency of the player |
transaction_id | String | Debit transaction ID |
bonus_amount | Integer | Bonus amount available in player’s wallet. If this amount is not available please send 0 value. |