Skip to main content

RefundRequest

sessionIDstringrequired

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

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

Globally unique identifier (UUID v4) for the refund 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
origTxIDuuidrequired

Original transaction ID (internal) on Swipe Games' side. This is the ID of the transaction that should be refunded. In some cases this original transaction ID might be not recorded on your side (timeout, server side error, etc).

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

Non unique ID for the round (internal) on Swipe Games' side. Could be the same for different games. Added in version 1.5.0. This field is optional for backward compatibility.

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

The amount of the refund 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. Refunds are always done for the whole bet amount.

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

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