Share via

Player Item Management - Add Character Virtual Currency

  • Reference
Service:
Server
API Version:
241108

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Increments the character's balance of the specified virtual currency by the stated amount

POST https://titleId.playfabapi.com/Server/AddCharacterVirtualCurrency

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
Amount True

number

Amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.
CharacterId True

string

Unique PlayFab assigned ID for a specific character owned by a user
PlayFabId True

string

PlayFab unique identifier of the user whose virtual currency balance is to be incremented.
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

ModifyCharacterVirtualCurrencyResult

400 Bad Request

ApiErrorWrapper

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

Name Description
AddCharacterVirtualCurrencyRequest
ApiErrorWrapper

The basic wrapper around every failed API response
ModifyCharacterVirtualCurrencyResult

AddCharacterVirtualCurrencyRequest

Name Type Description
Amount

number

Amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.
CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user
CustomTags

object

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

string

PlayFab unique identifier of the user whose virtual currency balance is to be incremented.
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

ModifyCharacterVirtualCurrencyResult

Name Type Description
Balance

number

Balance of the virtual currency after modification.
VirtualCurrency

string

Name of the virtual currency which was modified.

Error Codes

Name Code
InvalidVirtualCurrency 1051