API · Shop and balanceDocs navigation

Shop and balance API

Read-only. The balance is reported in the coin, with a USD estimate at the current price.

A withdrawal cannot be created through the API. To move a balance to your wallet, see Withdrawals and payouts.

Get the shop

GET /shop

Scope read_products

Returns the shop the key belongs to. Use it to confirm which shop a key is for before making other calls.

Request
curl -H "Authorization: Bearer YOUR_KEY" \
  https://api.shopl.io/api/v1/shop
200 OK
{
  "success": true,
  "data": {
    "id": "3f2a9c1b-7d44-4e0a-9a3c-1f5b8e2d6c70",
    "name": "North Keys",
    "slug": "north-keys",
    "description": "Game keys and software licences",
    "is_active": true,
    "created_at": "2026-04-01T12:00:00Z"
  }
}
Response fieldTypeNotes
idstringShop id (UUID)
namestringShop name
slugstringThe store URL segment: your-slug.shopl.io
descriptionstringShop description. Empty when none is set
is_activebooleanAlways true here: a key of an inactive shop is refused with 401
created_atstringWhen the shop was created

Get the balance

GET /balance

Scope read_analytics

Returns your crypto balance, one entry per gateway and coin the shop holds or has held.

Request
curl -H "Authorization: Bearer YOUR_KEY" \
  https://api.shopl.io/api/v1/balance
200 OK
{
  "success": true,
  "data": {
    "available_usd": 1204.55,
    "crypto_balances": [
      {
        "gateway": "oxapay",
        "currency": "USDT",
        "crypto_received": 2150.8,
        "crypto_withdrawn": 900,
        "crypto_pending": 46.25,
        "crypto_available": 1204.55,
        "current_price": 1,
        "current_usd": 1204.55,
        "historical_usd": 2150.8
      }
    ]
  }
}
Response fieldTypeNotes
available_usdnumberThe sum of current_usd over every entry
crypto_balances[].gatewaystringThe gateway that holds the coins, for example oxapay or cryptomus
crypto_balances[].currencystringCoin ticker in capitals
crypto_balances[].crypto_receivednumberCoins credited from orders
crypto_balances[].crypto_withdrawnnumberCoins in completed and processing withdrawals
crypto_balances[].crypto_pendingnumberCoins in pending withdrawals
crypto_balances[].crypto_availablenumberCoins you can withdraw now. Never below 0
crypto_balances[].current_pricenumberThe USD price Shoplio holds for the coin at the time of the call
crypto_balances[].current_usdnumbercrypto_available at current_price. An estimate, not a payout quote
crypto_balances[].historical_usdnumberThe USD value recorded when those coins were received
  • Amounts are in the coin, not in USD, except the three fields named usd.
  • Rely on crypto_available. It is not always crypto_received minus the withdrawn and pending amounts: an entry whose coins were converted from or to another coin also carries swap_in and swap_out.
  • A withdrawal is quoted at the price when you create it, so current_usd can differ from what a payout sends.

If the docs do not cover it, ask on Telegram or use the contact form.