This API request allows the credit of an amount to a player’s balance. This request is made when something goes wrong at the server / game-engine side and a previous debit request needs to be refunded. Its response would contain the information of any credited amount.
Refund() Request
Type | Input |
---|---|
HTTP Method | POST |
API URL | https://<API_BASE_URL>/refund |
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 credited to player’s wallet |
original_transaction_id | String | A transaction ID which is related to respective debit transaction. |
transaction_id | String | New refund transaction ID, should not be the same as the failed transaction. |
amount_type | String | Indicate type of amount type. It can be real only. |
currency | String | Currency of the player |
game_id | Integer | Unique ID of the game |
round_id | Bigint unsigned | Round ID related to the Debit request in question |
game_type | String | Type of the game. slots / table_games / scratch_cards / bing |
game_name | String | Name of the game |
note | String | Extra information about the cancel debit request |
Refund() Response + Example
{
"status": 0,
"account_id": "123123",
"country": "US",
"token": "3c2ef39d02581e2db3ddf6c713e83e05",
"balance": 12345,
"currency": "USD",
"transaction_id": "205354854449856",
}
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 |
currency | String | Currency of the player |
transaction_id | String | New refund transaction ID, should not be the same as the failed transaction. |