Skip to main content

WinRequest

typestringrequired

The type of the win.

  • regular type means regular bet,
  • free type means free bet (see Free Rounds section).

Possible values: [regular, free]

Example: regular
sessionIDstringrequired

The Game Session's ID (external). Provided by client via Create New Game call.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
amountstringrequired

The amount of the bet in currency main units (note: not cents). Currency selected by the client during the Create New Game call. We support 2 decimal places for all fiat currencies.

Possible values: Value must match regular expression ^(0|[1-9]\d*)(\.\d+)?$

Example: 100.10
txIDuuidrequired

Globally unique identifier (UUID v4) for the win transaction on Swipe Games' side. Must be used as an idempotency key on your side. Uniqueness is guaranteed by Swipe Games for a rolling 3-month window. For uniqueness guarantees beyond 3 months, use the composite key (txID + roundID).

Example: c27ccade-5a45-4157-a85f-7d023a689ea5
roundIDuuidrequired

Non unique ID for the round (internal) on Swipe Games' side. Could be the same for different games.

Example: b78e42f8-2041-482d-9c4b-f2ca79fc75e3
frIDstring

Free Rounds ID (external). This field is provided only for free rounds wins (where type is free), during bonus balance withdrawal process (type is regular).

Example: some_external_free_rounds_id
WinRequest
{
  "type": "regular",
  "sessionID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": "100.10",
  "txID": "c27ccade-5a45-4157-a85f-7d023a689ea5",
  "roundID": "b78e42f8-2041-482d-9c4b-f2ca79fc75e3",
  "frID": "some_external_free_rounds_id"
}