Skip to main content

Get player account balance​

Get account balance information for a player

Path Parameters
  • playerId string required

    id of player

    Example: 73619e57b3bc4b4e9014132be3bd12a9
Query Parameters
  • provider string required

    Name of the game provider associated with the session

    Example: Evolution
Header Parameters
  • X-Player-Token string required

    Possible values: >= 32 characters and <= 40 characters

    Player game session identifier

  • X-Correlation-ID string required

    Header for correlating requests between the services for debugging purposes and request tracing. The value will originate from the game providers that support request identification. Otherwise Valkyrie will generate a value.

  • traceparent string

    Describes the position of the incoming request in its trace graph. Further specified in https://www.w3.org/TR/trace-context

  • tracestate string

    Extends traceparent with vendor-specific data represented by a set of name/value pairs. Further specified in https://www.w3.org/TR/trace-context

Responses

The player balance summary

Schema
  • status string

    Possible values: [OK, ERROR]

  • error object

    Error details describing why PAM rejected the request

  • code string

    Possible values: [PAM_ERR_UNDEFINED, PAM_ERR_ACC_NOT_FOUND, PAM_ERR_GAME_NOT_FOUND, PAM_ERR_ROUND_NOT_FOUND, PAM_ERR_TRANS_NOT_FOUND, PAM_ERR_CASH_OVERDRAFT, PAM_ERR_BONUS_OVERDRAFT, PAM_ERR_SESSION_NOT_FOUND, PAM_ERR_SESSION_EXPIRED, PAM_ERR_MISSING_PROVIDER, PAM_ERR_TRANS_CURRENCY, PAM_ERR_NEGATIVE_STAKE, PAM_ERR_CANCEL_NOT_FOUND, PAM_ERR_TRANS_ALREADY_CANCELLED, PAM_ERR_CANCEL_NON_WITHDRAW, PAM_ERR_BET_NOT_ALLOWED, PAM_ERR_PLAYER_NOT_FOUND, PAM_ERR_API_TOKEN, PAM_ERR_TRANS_ALREADY_SETTLED, PAM_ERR_DUPLICATE_TRANS, PAM_ERR_PROMO_OVERDRAFT, PAM_ERR_TIMEOUT]

    • PAM_ERR_UNDEFINED - When you need a generic error.
    • PAM_ERR_ACC_NOT_FOUND - When account of playerId is not found.
    • PAM_ERR_GAME_NOT_FOUND - When specified providerGameId is not found.
    • PAM_ERR_ROUND_NOT_FOUND - In getGameRound, when there is no game round with id providerGameRoundId.
    • PAM_ERR_TRANS_NOT_FOUND - In DEPOSIT transaction if the game round with id providerRoundId is not found.
    • PAM_ERR_CASH_OVERDRAFT - When user does not have enough funds on their account for a withdraw transactions.
    • PAM_ERR_BONUS_OVERDRAFT - When user does not have enough funds on their bonus account for a withdraw transaction.
    • PAM_ERR_SESSION_NOT_FOUND - When no session is found for provided X-Player-Token.
    • PAM_ERR_SESSION_EXPIRED - When session related to X-Player-Token has expired.
    • PAM_ERR_MISSING_PROVIDER - When specified query parameter provider is not found.
    • PAM_ERR_TRANS_CURRENCY - When specified Currency does not match that of the session.
    • PAM_ERR_NEGATIVE_STAKE - When transaction amount is negative.
    • PAM_ERR_CANCEL_NOT_FOUND - When the transaction trying to cancel doesn't exist.
    • PAM_ERR_TRANS_ALREADY_CANCELLED - When trying to cancel an already cancelled transaction, or when a Deposit is made toward a cancelled withdraw.
    • PAM_ERR_CANCEL_NON_WITHDRAW - When trying to cancel a transaction that is not a Withdraw transaction.
    • PAM_ERR_BET_NOT_ALLOWED - When a bet cannot be done, eg when the user is blocked.
    • PAM_ERR_PLAYER_NOT_FOUND - When playerId is not found.
    • PAM_ERR_API_TOKEN - When Authorization header api token does not match the PAM api token.
    • PAM_ERR_TRANS_ALREADY_SETTLED - When trying to cancel an already Deposited bet or when trying to Deposit on an already finished gameRound, finished bet.
    • PAM_ERR_DUPLICATE_TRANS - When a Deposit is made with an already existing providerTransactionId but with different playerId/providerGameId/providerRoundId.
    • PAM_ERR_PROMO_OVERDRAFT - When user does not have enough funds on their promo account for a withdraw transaction.
    • PAM_ERR_TIMEOUT - A timeout occurred
  • message string
  • balance object

    player account balance

  • cashAmount double

    Funds on the account.

  • bonusAmount double

    Funds on the bonus account.

  • promoAmount double

    Amount in some currency, rounded to 6 decimal places

Loading...