General
General Information
Generate a signature
Deposits
Getting started
Create a deposit
Create a deposit without redirection (iframe)
Deposit notification (webhook)
Check an deposit status
Get a list of deposits
Deposits without 8-day waiting period (Steam Trade Protection)
Deposit approval with 8-day hold
Get failed webhook notifications
Deposits without SkinsBack UI
Create a deposit without SkinsBack UI (API)
Get user's inventory
Skins Withdraw
Skins price list
Skins search
Buy skin
Bulk buy skins
Get skin purchase info
Skin purchase history
Other
Get the project balance
Get the history of withdrawals and deposits of money
Get currencies and rates
Server status
Events real-time: websockets
Events real-time: webhooks
Check Deposit Status
This method is used to get information about the created deposit.
The required parameters are highlighted in blue.
Send a POST request to API Endpoint with the following parameters:
method
string
orderstatus
transaction_id
string
Transaction ID in our system
— OR —
order_id
string
Unique Order ID in your system
Response from the server:
If successful, a JSON object with the following contents will be sent in response:
status
string
success - payment successful, pending - waiting, fail - failed, in_hold - deposit on hold
A deposit with in_hold status can transition to either success or fail status.
Only for deposits without 8-day waiting period: hold_approved - on-hold deposit was approved, hold_returned - canceled approved on-hold deposit. More details...
A deposit with in_hold status can transition to either success or fail status.
Only for deposits without 8-day waiting period: hold_approved - on-hold deposit was approved, hold_returned - canceled approved on-hold deposit. More details...
transaction_id
string
Transaction ID in our system
order_id
string
Unique Order ID in your system
steam_id
string
User's Steam ID
date
int
Deposit creation date (UNIX time)
amount
double
The amount that the user deposited in the currency 'currency'
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
amount_currency
string
Payment currency
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
amount_in_currencies
object
Refill amount in all available currencies
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
user_amount
double
The amount that the user deposited multiplied by the value from the project settings
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
user_amount_in_currencies
object
The amount that the user deposited multiplied by the value from the project settings in all available currencies
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
offer_date
int
Trade offer creation date (UNIX)
(may be missing)
(may be missing)
in_hold_until
int
In hold until (UNIX time)
(may be missing, only for deposits with 8-day waiting period)
(may be missing, only for deposits with 8-day waiting period)
trade_offer_id
string
Trade Offer ID on Steam (may be missing)
skins_send_date
int
Trade Offer accept UNIX time (may be missing)
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
custom_currency
string
Custom currency name (if specified)
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
custom_currency_rate
double
Custom currency rate (if specified)
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
custom_currency_sum
double
The amount that the user deposited in the currency 'custom_currency'
(only when status = success, in_hold or hold_approved)
(only when status = success, in_hold or hold_approved)
reason
string
Reason for fail status:
1. 'timeout' - time to select skins has expired
2. 'trade_timeout' - time to accept trade on Steam has expired
3. 'trade_canceled' - trade has been cancelled on Steam
(only if status = fail)
1. 'timeout' - time to select skins has expired
2. 'trade_timeout' - time to accept trade on Steam has expired
3. 'trade_canceled' - trade has been cancelled on Steam
(only if status = fail)
List of possible errors:
1
order_id_or_transaction_id_missing
order_id and transaction_id is missing
2
invalid_order_id
Invalid order_id
3
invalid_transaction_id
Invalid transaction_id
4
transaction_not_found
Deposit not found
standard errors:
-1
please_use_post_method
Need to use the POST method
-2
invalid_shopid
Project Client ID not found in the system
-3
invalid_signature
Invalid signature
-4
shop_not_active
Project inactive
-5
invalid_method
Invalid API method
-7
request_limit_reached
API requests limit reached (500/per minute)
-8
invalid_ip_address
Specify IP address in merchant panel
-9
under_maintenance
Site under maintenance
-10
invalid_client_secret
Invalid X-CLIENT-SECRET header