Player Item Management - Add User Virtual Currency
Increments the user's balance of the specified virtual currency by the stated amount
POST https://titleId.playfabapi.com/Server/AddUserVirtualCurrency
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-SecretKey | True |
|
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
Amount | True |
|
Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded. |
PlayFabId | True |
|
PlayFab unique identifier of the user whose virtual currency balance is to be increased. |
VirtualCurrency | True |
|
Name of the virtual currency which is to be incremented. |
CustomTags |
|
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-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
Add |
|
Api |
The basic wrapper around every failed API response |
Modify |
AddUserVirtualCurrencyRequest
Name | Type | Description |
---|---|---|
Amount |
|
Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded. |
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
PlayFabId |
|
PlayFab unique identifier of the user whose virtual currency balance is to be increased. |
VirtualCurrency |
|
Name of the virtual currency which is to be incremented. |
ApiErrorWrapper
The basic wrapper around every failed API response
Name | Type | Description |
---|---|---|
code |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
ModifyUserVirtualCurrencyResult
Name | Type | Description |
---|---|---|
Balance |
|
Balance of the virtual currency after modification. |
BalanceChange |
|
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 |
|
User currency was subtracted from. |
VirtualCurrency |
|
Name of the virtual currency which was modified. |
Error Codes
Name | Code |
---|---|
InvalidVirtualCurrency | 1051 |
VirtualCurrencyCurrentlyUnavailable | 1512 |