TopUp/Vouchers + Deposit

Use these methods to sell TopUp top-ups and vouchers to customers, paying with the merchant's deposit (acquiring is not required).

---

Getting the list of TopUps

Get the list of categories (games) and available in-game top-ups

→ GET /api/v1/deposit/topups

Response parameters

Parameter	Type	Comment
categories	List	The list of categories (games)
id	String	Category number
name	String	Category name
fields	List	The list of required parameters for placing an order. Parameters differ between games
products	List	The list of items within the category (if the category is unavailable, the list is empty)
id	String	Item number
name	String	Item name
price	Number	The item's acquisition cost, in RUB
isAvailable	true/false	Item availability

---

Creating a TopUp deposit order

Create an order to purchase a game item, paying with the merchant's deposit

→ POST /api/v1/deposit/topups

Request parameters

Parameter	Required	Type	Comment
topupId	Yes	String	Item number
categoryId	Yes	String	Category number
orderId	Yes	String	Order number
fields	No	Object	Required parameters for placing an order. The set depends on the selected category — see Getting the list of TopUps
email	Yes	String	User's email

Response parameters

Parameter	Type	Comment
orderId	String	Order number
topupId	String	Item number
categoryId	String	Category number
price	Number	The item's acquisition cost, in RUB (debited from the deposit)
status	String	Order status
fields	Object	Parameters passed when creating the order
email	String	User's email

---

Getting the list of vouchers

Get the list of categories (services) and available vouchers within them

→ GET /api/v1/deposit/vouchers

Response parameters

Parameter	Type	Comment
categories	List	The list of categories (services)
id	String	Category number
name	String	Category name
products	List	The list of vouchers within the category (if the category is unavailable, the list is empty)
id	String	Voucher number
name	String	Voucher name
price	Number	The voucher's acquisition cost, in RUB
stock	Number	Number of available vouchers
isAvailable	true/false	Voucher availability

---

Creating a voucher deposit order

Create an order to purchase vouchers, paying with the merchant's deposit

→ POST /api/v1/deposit/vouchers

Request parameters

Parameter	Required	Type	Comment
voucherId	Yes	String	Voucher number
categoryId	Yes	String	Category number
count	Yes	Number	Number of vouchers to purchase
orderId	Yes	String	Order number
email	Yes	String	User's email

Response parameters

Parameter	Type	Comment
orderId	String	Order number
voucherId	String	Voucher number
categoryId	String	Category number
count	Number	Number of vouchers purchased
price	Number	The vouchers' acquisition cost, in RUB (debited from the deposit)
status	String	Order status
codes	List	The list of voucher codes (appear after the order is fulfilled)
email	String	User's email

---

Checking order status

Checking order status is a shared method for all deposit-based products, see Deposit Operations