Skip to main content

Authorizations

​
Authorization
string
header
required

Checkout creation uses the opaque ten-minute session token. Deposit status reads use the deposit-specific statusToken returned only by a successful deposit POST.

Headers

​
Idempotency-Key
string
required
Required string length: 16 - 255
Pattern: ^[A-Za-z0-9._~:/-]{16,255}$

Body

application/json
​
itemIds
string[]
required
Required array length: 1 - 250 elements
Required string length: 1 - 200
​
game
enum<string>
Available options:
cs2,
rust

Response

Existing deposit returned for an idempotent replay

expiresAt is the checkout offer-acceptance deadline, not a status capability expiry. A valid statusToken remains usable after the checkout session expires so a protected trade can complete.

​
depositId
string
required
Pattern: ^dep_[A-Za-z0-9_-]{20,}$
​
botDisplayName
string | null
required
Maximum string length: 200
​
botProfileUrl
string | null
required
Pattern: ^https://steamcommunity\.com/profiles/[0-9]{17}$
​
items
object[]
required
Minimum array length: 1
​
total
string
required
Pattern: ^(0\.[0-9]{2}|[1-9][0-9]*(\.[0-9]{2})?)$
​
requiredAmount
string
required
Pattern: ^(0\.[0-9]{2}|[1-9][0-9]*(\.[0-9]{2})?)$
​
overpaymentMinor
integer
required
Required range: x >= 0
​
currency
string
required
Allowed value: "USD"
​
game
enum<string>
required
Available options:
cs2,
rust
​
state
enum<string>
required
Available options:
initiated,
pending,
active,
hold,
completed,
canceled,
declined,
failed,
reverted,
expired,
reconciliation_required
​
expiresAt
string<date-time>
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
pollAfterSeconds
integer
required
Required range: x >= 1
​
statusToken
string
required

Returned on deposit creation and required for later status reads.

Pattern: ^st_[A-Za-z0-9_-]{43}$
​
reservationRequired
boolean
required
​
fulfillmentAllowed
boolean
required
​
holdUntil
string<date-time> | null
required
​
warnings
object[]
required