Sync with Waxpeer session to auto-fill API key

Fetch a list of merchant deposits

GET/v2/merchant/deposits

Fetch a list of merchant deposits within a specified date range. Limit 200 records per response.

Parameters

NameLocationTypeDescription
api
required
querystring
merchant
required
querystring

Your merchant name

steam_id
optional
querystring

Steam ID (17 digits)

start
required
querystring

Start date in YYYY-MM-DD format

end
required
querystring

End date in YYYY-MM-DD format

start_from
optional
queryinteger

Start from transaction ID (for pagination)

Responses

200 **Please open the schema to see the response structure, fields, and their descriptions**

NameTypeDescription
status
required
string
deposits
required
array<object>

List of deposits

transaction_id
optional
integer

Transaction ID of the deposit

deposit_id
optional
string

Your unique custom deposit ID

merchant
optional
string

Merchant name

steam_id
optional
string

Steam ID (17 digits)

trade_url_token
optional
string

Trade URL token (8 characters)

currency
optional
string

Currency code (e.g., USD, EUR)

min_amount
optional
number

Minimum amount

max_amount
optional
number

Maximum amount

result_url
optional
string

URL to send the result to

fail_url
optional
string

URL to redirect to on failure

success_url
optional
string

URL to redirect to on success

game
optional
enum

Game type

enum: csgo

priority_game
optional
enum

Priority game

enum: csgo

hash
optional
string

Hash identifier (Used for tracking the deposit on redirect or widget)

widget
optional
boolean

Flag to indicate widget usage

steam_trade
optional
integer

Internal ID of the associated Steam trade

created
optional
string

Timestamp when the deposit was created

items
optional
array<string>

List of item IDs associated with the deposit

steam_trade_data
optional
object

Details about the Steam trade

trade_id
optional
string

Steam trade offer ID

done
optional
boolean

Trade completion status

reason
optional
enum

Reason for failure (if any)

enum: Buyer failed to accept, Seller failed to accept, Invalid buyer tradelink

created
optional
string

Timestamptz when the trade was created

proccessed_time
optional
string

Timestamptz when the trade was processed

user
optional
object

User details

name
optional
string

Cached user's Steam name

avatar
optional
string

Cached user's Steam avatar URL

steam_id
optional
string

User's Steam ID

items
optional
array<object>

List of items in the trade

item_id
optional
string

Steam item ID (asset ID)

name
optional
string

Item name

price
optional
number

Price of the item (1000 = 1$)

give_amount
optional
number

How much you received (1000 = 1$)

status
optional
number

Status of the trade:

6->Declined and refunded

5->Completed

4->Trade sent and can be accepted

2->Waiting for seller to confirm trade on mobile

1->Processing and creating the trade

0->Waiting for user to buy more items and if the user doesn't buy more items then the status will automatically change with in a certain period

start_from
required
number

Next transaction ID to use for pagination. If not present or response have no records, there are no more records to fetch

Response
{
  "status": "success",
  "deposits": [
    {
      "transaction_id": 123456,
      "deposit_id": "123456asd",
      "merchant": "mymerchant",
      "steam_id": "76561198000000000",
      "trade_url_token": "abcdefgh",
      "currency": "USD",
      "min_amount": 10,
      "max_amount": 100,
      "result_url": "https://yourwebsite.com/result",
      "fail_url": "https://yourwebsite.com/fail",
      "success_url": "https://yourwebsite.com/success",
      "game": "csgo",
      "priority_game": "csgo",
      "hash": "7USFcwzEvgxs6l2u3ow4IQxlgJBYEZZt",
      "widget": true,
      "steam_trade": 789012,
      "created": "2023-10-05T12:34:56Z",
      "items": [
        "123",
        "456",
        "789"
      ],
      "steam_trade_data": {
        "trade_id": "1234567890",
        "done": true,
        "reason": "Seller failed to accept",
        "created": "2023-10-05T12:34:56Z",
        "proccessed_time": "2023-10-05T12:40:00Z",
        "user": {
          "name": "SteamUser",
          "avatar": "https://avatars.cloudflare.steamstatic.com/0ac149f87545bf80733f29d079e29c0904ceb171_full.jpg",
          "steam_id": "76561198000000000"
        },
        "items": [
          {
            "item_id": "141414144",
            "name": "AWP | Asiimov (Field-tested)",
            "price": 1000,
            "give_amount": 1000,
            "status": 4
          }
        ]
      }
    }
  ],
  "start_from": 123456
}