ZEPETO.Currency
9 min
type description balancerecord /#balancerecord balance information for a specific currency balanceresponse /#balanceresponse the balanceresponse class provides the api call result and the balance information balancelistresponse /#balancelistresponse the balancelistresponse class provides the api call result and the balance information list currencyservice /#currencyservice currencyservice manages operations associated with zepeto world currencies this service enables players to check their balances for both the official zepeto currency (zem) and in world currencies currencyerror /#currencyerror the error code specifies the reason for the failure of currency related requests balancerecord class balance information for a specific currency properties name type description currencyid string id of the in world currency set to an empty string for zepeto’s official currency (zem) quantity bigint player's balance for the currency balanceresponse class · extends productbaseresponse the balanceresponse class provides the api call result and the balance information properties name type description currency balancerecord /#balancerecord balance information balancelistresponse class · extends productbaseresponse the balancelistresponse class provides the api call result and the balance information list properties name type description currencies dictionary\<string, bigint> collection mapping in world currency ids to the player's balance for each currency currencyservice class currencyservice manages operations associated with zepeto world currencies this service enables players to check their balances for both the official zepeto currency (zem) and in world currencies methods getusercurrencybalancesasync static getusercurrencybalancesasync() → baserequest\<balancelistresponse> this asynchronous method retrieves the balance information for every defined in world currency returns baserequest\<balancelistresponse> — a baserequest object when the asynchronous process is complete, you can access the balancelistresponse object by the responsedata property getusercurrencybalanceasync static getusercurrencybalanceasync(currencyid string) → baserequest\<balanceresponse> this asynchronous method retrieves the balance for a specific in world currency based on the provided currency id parameter type description currencyid string id of the currency to fetch returns baserequest\<balanceresponse> — a baserequest object when the asynchronous process is complete, you can access the balanceresponse object by the responsedata property getofficialcurrencybalanceasync static getofficialcurrencybalanceasync() → officialcurrencybalancerequest this asynchronous method retrieves the balance for zepeto’s official currency (zem) returns officialcurrencybalancerequest — a officialcurrencybalancerequest object when the asynchronous process is complete, you can access the balanceresponse object by the responsedata property currencyerror enum the error code specifies the reason for the failure of currency related requests name value description unknown 1 error unknown error networkerror 0 error errors related to network issues, including disconnections or unstable connections
