Deposit
v1.0.0This method makes a deposit into players account. The method sends transaction and returns transaction ID, player balance and status of transaction.
- Path: /deposit
- Request Method: POST
- Content-Type: application/json; charset=utf-8
- Headers: X-Art-Client-ID, X-Art-Client-TS, X-Art-Client-Signature
Request
| Parameter | Type | Description |
|---|---|---|
| user_id | string | Player ID |
| currency | string [currency enum] | Bet currency (currency code) |
| amount | long | Amount that should be transferred to players balance |
| provider | string | Game provider |
| provider_tx_id | string | The transaction ID assigned by provider |
| game | string [game enum] | Identifies specific game. (game identificator) |
| action | string | Type of action: betrainfreebetrainfreebetpromofreebetchallengefreebetchallengeprizemoney |
| action_id | string | ID of action in game, which depends on game and “action” |
| session_token | string | Game session token |
| platform | string [platform enum] | Enum: mobiledesktop |
| withdraw_provider_tx_idoptional | string | Provider id of withdrawn transaction, to which belongs current deposit transaction. |
Response
| Parameter | Type | Description |
|---|---|---|
| code | integer [enum] | Response code |
| message | string | Response any logical message |
| data | object | only needed when code 200 or 409 |
| user_id | string | ID of a player on the operators side |
| operator_tx_id | string | Unique transaction ID on side of operator |
| provider | string | Game provider |
| provider_tx_id | string | The transaction ID received by provider |
| old_balance | long | Balance before deposit |
| new_balance | long | Balance after deposit |
| currency | string [currency enum] | Transaction currency |
Important!
Each request sent to the API requires validation using specific security headers. For details on implementing this, refer to Securing API Requests.
If request gets on timeout, or an internal error, game sends same transaction, with same provider_tx_id again. If transaction is already processed on the side of the operator, operator identifies duplication and adds in answer duplication error code with processed information of transaction. The Transaction should be unique with provider_tx_id.
Amount/Balance example
Amount/Balance fiat is represented in units(1$ = 1000 unit) and always is an integer value. For example: with 5.32 USD and the value will be 5.32 * 10^3 = 5320
Amount/Balance crypto is represented in units(1BTC = 100000000 unit) and always is an integer value. For example: with 0.0532 BTC and the value will be 0.0532 * 10^8 = 5320000
Possible codes
- 200 - Success
- 401 - User token is invalid
- 403 - User token is expired
- 409 - Duplicate transaction
- 413 - Invalid Client-Signature
- 500 - Internal error
If code is 200 - operator should always return parameter data with information; HTTP status code should always be 200