Documentation

AddVirtualCurrencyTypes

Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded.

Request Details

This operation is additive. Any new currencies defined in the array will be added to the set of those available for the title, while any CurrencyCode identifiers matching existing ones in the game will be overwritten with the new values.

AddVirtualCurrencyTypesRequest
Request Properties
VirtualCurrencies (required) List<VirtualCurrencyData>

List of virtual currencies and their initial deposits (the amount a user is granted when signing in for the first time) to the title

POST https://{{TitleID}}.playfabapi.com/Admin/AddVirtualCurrencyTypes
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "VirtualCurrencies": [
    {
      "CurrencyCode": "CC",
      "DisplayName": "Chump Coins",
      "InitialDeposit": 100,
      "RechargeRate": 1000,
      "RechargeMax": 1000
    },
    {
      "CurrencyCode": "GC"
    }
  ]
}
        

Response Details

BlankResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
InvalidVirtualCurrencyCode 1236
VirtualCurrencyCountLimitExceeded 1229