Deposit

POST /wallet/deposit

Headers

application/json

Body Required

  • amount number Required

    The total amount of the transaction in the currency of the transaction. This amount is the sum of the cash amount and the jackpot amount.

  • cashAmount number Required

    The cash contribution to the amount field in the currency of the transaction. This field is mainly for analytics purposes.

  • currency string Required
  • freeSpinsCampaignId string
  • gameId string Required
  • gameRoundId string Required
  • isForceComplete boolean | null

    Indicates if the win is sent outside of player session. This can happen in case of failed transaction retries or auto completed game rounds .

  • isFreeSpinsConsumed boolean | null

    Indicates if all free spins were consumed. This property will be always null for non free spins transactions. For integrations that have free spins aggregation enabled, this property will be true for the last and the only free spins win transaction. The amount of the resulting deposit transaction will be the aggregated amount of all free spins wins.

  • isGameRoundFinished boolean Required
  • jackpotAmount number | null

    The jackpot contribution to the amount field in the currency of the transaction. This field is mainly for analytics purposes. If the transaction does not involve a jackpot, this field should be set to null.

    Minimum value is 0.

  • playerId string Required
  • sessionId string Required
  • transactionId string Required
  • withdrawTransactionId string Required

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • balance number Required
    • currency string Required
    • resolveTimestamp integer(int32)

      Epoch time in milliseconds. Optional resolve timestamp of the transaction. If this is set, the transaction will be applied to the financial reports with the given timestamp. Recommended approach is to ignore this property.
  • 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
POST /wallet/deposit 
curl \
 -X POST BASE_URL/wallet/deposit \
 -H "Content-Type: application/json" \
 -H "Signature: string" \
 -H "Public-Key: string" \
 -d '{"amount":42.0,"cashAmount":42.0,"currency":"string","freeSpinsCampaignId":"string","gameId":"string","gameRoundId":"string","isForceComplete":true,"isFreeSpinsConsumed":true,"isGameRoundFinished":true,"jackpotAmount":42.0,"playerId":"string","sessionId":"string","transactionId":"string","withdrawTransactionId":"string"}'
Request examples 
# Headers
Signature: string
Public-Key: string

# Payload
{
  "amount": 42.0,
  "cashAmount": 42.0,
  "currency": "string",
  "freeSpinsCampaignId": "string",
  "gameId": "string",
  "gameRoundId": "string",
  "isForceComplete": true,
  "isFreeSpinsConsumed": true,
  "isGameRoundFinished": true,
  "jackpotAmount": 42.0,
  "playerId": "string",
  "sessionId": "string",
  "transactionId": "string",
  "withdrawTransactionId": "string"
}
Response examples (200) 
{
  "balance": 42.0,
  "currency": "string",
  "resolveTimestamp": 42
}
Response examples (400) 
{
  "code": "ERROR_UNKNOWN_ERROR",
  "description": "string",
  "traceId": "string"
}
Response examples (401) 
{
  "code": "ERROR_INVALID_SIGNATURE",
  "description": "string",
  "traceId": "string"
}
Response examples (500) 
{
  "code": "ERROR_UNKNOWN_ERROR",
  "description": "string",
  "traceId": "string"
}