Player Item Management - Add User Virtual Currency

  • Reference
Service:
Client
API Version:
220718

Increments the user's balance of the specified virtual currency by the stated amount

POST https://titleId.playfabapi.com/Client/AddUserVirtualCurrency

Request Header

Name Required Type Description
X-Authorization True
  • string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
Amount True
  • number

Amount to be added to the user balance of the specified virtual currency.
VirtualCurrency True
  • string

Name of the virtual currency which is to be incremented.
CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

AddUserVirtualCurrencyRequest

This API must be enabled for use as an option in the game manager website. It is disabled by default.
ApiErrorWrapper

The basic wrapper around every failed API response
ModifyUserVirtualCurrencyResult

AddUserVirtualCurrencyRequest

This API must be enabled for use as an option in the game manager website. It is disabled by default.

Name Type Description
Amount
  • number

Amount to be added to the user balance of the specified virtual currency.
CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
VirtualCurrency
  • string

Name of the virtual currency which is to be incremented.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code
error
  • string

Playfab error code
errorCode
  • integer

Numerical PlayFab error code
errorDetails
  • object

Detailed description of individual issues with the request object
errorMessage
  • string

Description for the PlayFab errorCode
status
  • string

String HTTP code

ModifyUserVirtualCurrencyResult

Name Type Description
Balance
  • number

Balance of the virtual currency after modification.
BalanceChange
  • number

Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.
PlayFabId
  • string

User currency was subtracted from.
VirtualCurrency
  • string

Name of the virtual currency which was modified.

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
InvalidVirtualCurrency 1051
VirtualCurrencyCurrentlyUnavailable 1512