Wallet API

Withdraw

Takes money from the player: a bet's stake, or the money a player shares in chat.

Path/withdraw

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 player places a bet (action: "bet").
When a player makes it rain or tips another player (action: "rain").

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	`bet` for a stake, `rain` for money a player shares with others in chat.
`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`.

Request body

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

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": "884120",
    "user_id": "100245",
    "provider": "avionix",
    "provider_tx_id": 5823019,
    "old_balance": 1500.5,
    "new_balance": 1400.5,
    "currency": "KES"
  }
}

Result codes

Code	Meaning
`200`	Money taken: the bet plays.
`402`	Not enough balance: the bet is refused and nothing was taken.
`403`	Account blocked or not allowed to bet.
`404`	No such player.
`500`	Unclear: see No clear answer below.

Every method: see Result codes.