Documentation

RemoveVirtualCurrencyTypes

Removes one or more virtual currencies from the set defined for the title.

Request Details

Virtual currencies to be removed cannot have entries in any catalog nor store for the title. Note that this operation will not remove player balances for the removed currencies; if a deleted currency is recreated at any point, user balances will be in an undefined state.

RemoveVirtualCurrencyTypesRequest
Request Properties
VirtualCurrencies (required) List<VirtualCurrencyData>

List of virtual currencies to delete

POST https://{{TitleID}}.playfabapi.com/Admin/RemoveVirtualCurrencyTypes
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "VirtualCurrencies": [
    {
      "CurrencyCode": "CC"
    },
    {
      "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
VirtualCurrencyCannotBeDeleted 1237