Skip to main content

Deposit Operations

Shared methods for all products that work through the merchant's deposit (Steam + Deposit, TopUp/Vouchers + Deposit).


Getting the current deposit balance

Get the merchant's current deposit balance

GET /api/v1/deposit/balance

Response parameters

ParameterTypeComment
totalBalanceNumberThe total deposit balance, in RUB
frozenBalanceNumberThe frozen part of the balance (reserved for orders being processed), in RUB
availableBalanceNumberThe balance available for new orders, in RUB

Getting deposit order status

Check the order status by number — a shared method for orders of any deposit product (Steam, TopUp, vouchers)

GET /api/v1/deposit/order/{orderId}

Request parameters

ParameterRequiredTypeComment
orderIdYesStringOrder number

Response parameters

ParameterTypeComment
orderIdStringOrder number
priceNumberThe order cost (debited from the deposit)
statusStringOrder status. Possible values: Pending (being fulfilled), Success (order fulfilled), Fail (error)
typeStringOrder type (for example, Steam, TopUp, Vouchers)
detailsObjectAdditional order details depending on the type (may be null)