Wallet API

Deposit

Pays money to the player: a win, a rollback, or money received from chat or a free bet.

Path/deposit

MethodPOST

Content-Typeapplication/json

HeadersX-Client-IDX-Client-TSX-Client-Signature

Appended to your wallet base URL. Signed: see Securing requests.

When we call it

When a bet wins: the full payout, stake included (action: "win").
When a stake goes back (action: "rollback", see Rollback).
When a player claims rain or a tip, or a free bet wins (action: "claim").

Request

Parameter	Type	Description
`user_id`required	string	Your player ID, as your `/auth` returned it.
`session_token`required	string	The launch token the player opened the game with.
`currency`required	string	Currency code, e.g. `KES`.
`amount`required	number	The amount to move, in the agreed unit (see Amounts). Never negative.
`game`required	string	The game code, e.g. `avionix` (see Games).
`action`required	string	`win`, `rollback` or `claim`.
`provider`required	string	Who is calling: the same value as `X-Client-ID`.
`provider_tx_id`required	integer	Our transaction ID: the bet's ID for stakes, wins and rollbacks. Unique per game server; store it as text.
`action_id`required	integer	Same value as `provider_tx_id`.
`platform`required	string	Device type. Currently always `mobile`.
`withdraw_provider_tx_id`required	integer	The `provider_tx_id` of the bet being paid (same value as `provider_tx_id`). For a `claim` there may be no such withdraw.

Request body

{
  "user_id": "100245",
  "session_token": "8f3c1d2e9b7a4c5d8e1f2a3b4c5d6e7f",
  "currency": "KES",
  "amount": 250,
  "game": "avionix",
  "action_id": 5823019,
  "action": "win",
  "provider": "avionix",
  "provider_tx_id": 5823019,
  "platform": "mobile",
  "withdraw_provider_tx_id": 5823019
}

Response

Field	Type	Description
`code`required	integer	`200` when the money moved (or had already moved, for a repeat).
`message`required	string	`ok`, or the reason for a refusal (shown to the player).
`data.old_balance`required	number	The balance before this transaction.
`data.new_balance`required	number	The balance after it.
`data.operator_tx_id`optional	string	Your transaction ID, for reconciliation.
`data.user_id`optional	string	Echo of the request.
`data.provider`optional	string	Echo of the request.
`data.provider_tx_id`optional	integer	Echo of the request.
`data.currency`optional	string	The balance currency.

Response

{
  "code": 200,
  "message": "ok",
  "data": {
    "operator_tx_id": "884133",
    "user_id": "100245",
    "provider": "avionix",
    "provider_tx_id": 5823019,
    "old_balance": 1400.5,
    "new_balance": 1650.5,
    "currency": "KES"
  }
}

Result codes

Code	Meaning
`200`	Paid.
`404`	No such player (the payout is retried, then left for you to settle).
`500`	Unclear: the payout is retried.

Every method: see Result codes.