Get current user's virtual balance

Digital Distribution Hub API

In-Game Store & Buy Button API

Overview

Download API definition

USER ATTRIBUTES

Admin

Personalized Catalog

BUNDLES

Admin

Catalog

CART & PAYMENT

Cart (client-side)

Cart (server-side)

Payment (client-side)

Payment (server-side)

Order

Free items

COMMON

Webhooks

Pre-Orders

Merchant

Catalog

Common regions

GAME KEYS

Catalog

Entitlement

Admin

PLAYER INVENTORY

Client

get

Get current user's inventory

get

Get current user's virtual balance

get

Get current user's time-limited items

post

Consume item

Management

Cross-Inventory

PROMOTIONS

Common

Coupons

Promo Codes

Unique catalog offers

Discounts

Bonuses

VIRTUAL ITEMS & CURRENCY

Admin

Catalog

Virtual Payment

NFT ITEMS

Admin

Catalog

LIMITS

Management

REWARD CHAINS & VALUE POINTS

Admin

Client

Pay Station API

Publisher Account API

Subscriptions API

Webhooks

Get current user's virtual balance

get/v2/project/{project_id}/user/virtual_currency_balance

Client endpoint. Retrieves the current user’s virtual balance.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id

required

integer

Default: 44056

Project ID.

query Parameters

platform

string

Default: "xsolla"

Publishing platform the user plays on.

Enum: "playstation_network" "xbox_live" "xsolla" "pc_standalone" "nintendo_shop" "google_play" "app_store_ios" "android_standalone" "ios_standalone" "android_other" "ios_other" "pc_other"

Responses

200

The user’s virtual balance was successfully retrieved.

Request samples

Response samples

application/json

{"items": [{"sku": "VC_1",
"type": "virtual_currency",
"name": "Ruble",
"amount": 10,
"description": "Ruble",
"image_url": "https://picture.bigrocket.png"
},
{"sku": "VC_2",
"type": "virtual_currency",
"name": "Xsollar",
"amount": 5000,
"description": "Xsollar",
"image_url": "http://image.png"
}
]
}