Create free spin event - VA Docs

Creates a free spin event.

Path

POST {host}/vendor/v2.0/freespin/create

Headers

Field	Type	Required	Description
`Authorization`	string	Yes	Token we provide
`Content-Type`	string	Yes	`multipart/form-data`

Request parameters

Field	Type	Required	Signed	Description
`channelID`	number	Yes	✓	Channel ID (0 means all channels)
`startTime`	string	Yes	✓	Start time (see Time format)
`endTime`	string	Yes	✓	End time (see Time format)
`eventName`	string	Yes	✓	Event name
`currency`	string	Yes	✓	Currency (contact our business team)
`gameIDList`	number[]	Yes	✓	Eligible game IDs (at least 1, no duplicates, each greater than 0). In form-data, repeat the field once per value.
`minWithdraw`	string	Yes	✓	Minimum payout (amount string, 0.01–999,999,999, up to 2 decimal places)
`maxWithdraw`	string	Yes	✓	Maximum payout (amount string, 0.01–999,999,999, up to 2 decimal places, at least minWithdraw)
`freeSpinTimes`	number	Yes	✓	Number of free spins (integer from 1 to 99)
`validDays`	number	Yes	✓	Valid days (1–31)
`joinOptions`	string[]	Yes	✓	Join options (1–2 items, no duplicates, only auto or add). auto: every member of the channel can join until the quota is full. add: members you specify with Grant free spins join until the quota is full. In form-data, repeat the field once per value.
`allowDuplicateJoin`	string	No	✓	Whether one member can receive multiple grants (true / false; empty means false). Must be false when joinOptions includes auto.
`maxGrantCount`	number	Yes	✓	Maximum number of grants (1–99,999)
`maxGrantsPerMember`	number	Yes	✓	Maximum grants per member (at least 1). Must be 1 when allowDuplicateJoin=false; at least 1 when allowDuplicateJoin=true.
`bet`	string	Yes	✓	Bet per spin (amount string, 0.01–999,999,999, up to 2 decimal places)
`zoneID`	string	No	✓	Display time zone (GMT-12 to GMT+12; empty means GMT+8)
`giftCodes`	string	No	✓	Gift codes (not yet supported; only applies when joinOptions includes add). JSON string format: [{“code”:“GC2024NY”,“total”:100}]; code is 5–10 alphanumeric characters; total is an integer of at least 1.
`settlePerSpin`	string	No	✓	Settlement mode (true / false; true pays out on every spin; empty means false)
`sign`	string	Yes		Signature. See Signature for how to generate it

Response

Success (the HTTP status code is always 200; check status.code for the result)

Field	Type	Description
`data`	object
`data.eventID`	string	Event ID (24-character hex)
`status`	object	Response status. See Response format

Response example

{
  "data": {
    "eventID": "abccc1234567890aaaaa1254"
  },
  "status": {
    "code": "0",
    "message": "success",
    "datetime": "2022-07-01T10:13:54.920+08:00",
    "traceCode": "7cf25e1957cc47fe8e01f1a7c6d504d6"
  }
}

Response codes

Besides the common codes, this API may also return:

Code	Description
`206`	Game does not exist
`429`	Too many requests