Title-Wide Data Management - List Virtual Currency Types
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Retuns the list of all defined virtual currencies for the title
POST https://titleId.playfabapi.com/Admin/ListVirtualCurrencyTypes
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. |
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
Name | Description |
---|---|
Api |
The basic wrapper around every failed API response |
List |
|
List |
|
Virtual |
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 |
ListVirtualCurrencyTypesRequest
ListVirtualCurrencyTypesResult
Name | Type | Description |
---|---|---|
VirtualCurrencies |
List of virtual currency names defined for this title |
VirtualCurrencyData
Name | Type | Description |
---|---|---|
CurrencyCode |
string |
unique two-character identifier for this currency type (e.g.: "CC") |
DisplayName |
string |
friendly name to show in the developer portal, reports, etc. |
InitialDeposit |
number |
amount to automatically grant users upon first login to the title |
RechargeMax |
number |
maximum amount to which the currency will recharge (cannot exceed MaxAmount, but can be less) |
RechargeRate |
number |
rate at which the currency automatically be added to over time, in units per day (24 hours) |