Title-Wide Data Management - Remove 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. Removes one or more virtual currencies from the set defined for the title.
POST https://titleId.playfabapi.com/Admin/RemoveVirtualCurrencyTypes
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 |
---|---|---|---|
VirtualCurrencies | True |
List of virtual currencies to delete |
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 |
Blank |
|
Remove |
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. |
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 |
BlankResult
RemoveVirtualCurrencyTypesRequest
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.
Name | Type | Description |
---|---|---|
VirtualCurrencies |
List of virtual currencies to delete |
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) |
Error Codes
Name | Code |
---|---|
InvalidVirtualCurrencyCode | 1236 |
VirtualCurrencyCannotBeDeleted | 1237 |
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기