Headers

• Signature string Required
• Public-Key string Required

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • betCount integer(int32) Required

    Total bet count for the player in the campaign

  • betValue number Required

    The bet value the campaign freespins are offered to the player

  • betsPlayed integer(int32) Required

    Current number of bets played for the player in the campaign

  • campaignId string Required

    A campaign ID that was provided during creation

  • campaignName string Required

    Non blank campaign name

    Format should match the following pattern: ^(?!\s*$).+.

  • consumeBefore integer(int64)

    Unix epoch time in milliseconds. Must be in the future. Consume before is considered to be hard end date, after which the campaign should be expired.

  • currency string Required

    Non blank currency

    Format should match the following pattern: ^(?!\s*$).+.

  • gameId string Required

    Non blank game ID

    Format should match the following pattern: ^(?!\s*$).+.

  • handoverAfter integer(int64)

    Unix epoch time in milliseconds. Start date of the campaign. Must be in the future.

  • status string Required

    Current status for the player campaign

    Format should match the following pattern: ^(?!\s*$).+. Values are DRAFT, READY, ACTIVE, EXPIRED, FAILED, CANCELLED, or DECLINED.

  • totalBetAmount number Required

    Current total bet amount for the player in the campaign

  • totalWinAmount number Required

    Current total win amount for the player in the campaign

• 400 application/json

  Request could not be processed

  Hide response attributes Show response attributes object

  • code string

    Values are ERROR_UNKNOWN_ERROR, ERROR_BAD_REQUEST, ERROR_BAD_REQUEST_PLAYER_BLOCKED, ERROR_INVALID_SESSION, ERROR_SESSION_EXPIRED, ERROR_TRANSACTION_DUPLICATE, ERROR_TRANSACTION_WITHDRAW_NOT_FOUND, ERROR_TRANSACTION_INSUFFICIENT_FUNDS, ERROR_TRANSACTION_LIMIT_EXCEEDED, ERROR_TRANSACTION_REALITY_CHECK, ERROR_TRANSACTION_NOT_FOUND, ERROR_ROLLBACK_TRANSACTION_NOT_FOUND, or ERROR_GAME_NOT_ACTIVE.

  • description string

    Message describing the error

  • traceId string

    Internal ID to trace the request when debugging

• 401 application/json

  Request public key or signature is missing or invalid

  Hide response attributes Show response attributes object

  • code string

    Value is ERROR_INVALID_SIGNATURE.

  • description string

    Message describing the error

  • traceId string

    Internal ID to trace the request when debugging

• 500 application/json

  Internal error / Unknown error

  Hide response attributes Show response attributes object

  • code string

    Values are ERROR_UNKNOWN_ERROR or ERROR_TIMEOUT.

  • description string

    Message describing the error

  • traceId string

    Internal ID to trace the request when debugging