---
title: ZEPETO.Currency
slug: world-sdk-guide/zepetocurrency
docTags: 
createdAt: 2026-08-28T01:32:10.500Z
---

| 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. |