Get virtual currency

Get virtual currencyServer-sideAdmin

get/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}

Gets the virtual currency within a project for administration.

Note

Do not use this endpoint for building a store catalog.

Request

path Parameters

project_id required	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056
virtual_currency_sku required	string Virtual currency SKU. Example: crystal

query Parameters

promo_code

string [ 1 .. 128 ] characters

Unique case sensitive code. Contains letters and numbers.

Example: promo_code=WINTER2021

Responses

200

The specified virtual currency was successfully received.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

404

The item was not found. Make sure the project_id and the item_sku are correct.

Request samples

Response samples

application/json

{"sku": "crystal",
"name": {"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [{"external_id": "attr_1",
"name": {"en-US": "OK"
},
"values": [{"external_id": "val1",
"value": {"en-US": "VALUE"
}
},
{"external_id": "val2",
"value": {"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [ ],
"prices": [{"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [ ],
"vc_prices": [ ],
"is_enabled": true,
"is_show_in_store": true,
"regions": [ ],
"inventory_options": {"consumable": true,
"expiration_period": null
},
"is_hard": false,
"limits": {"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [ ],
"custom_attributes": {"purchased": 0,
"attr": "value"
}
}