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
Returns the shop the key belongs to. Use it to confirm which shop a key is for before making other calls.
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 field | Type | Notes |
|---|---|---|
id | string | Shop id (UUID) |
name | string | Shop name |
slug | string | The store URL segment: your-slug.shopl.io |
description | string | Shop description. Empty when none is set |
is_active | boolean | Always true here: a key of an inactive shop is refused with 401 |
created_at | string | When the shop was created |
Get the balance
GET /balance
Returns your crypto balance, one entry per gateway and coin the shop holds or has held.
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 field | Type | Notes |
|---|---|---|
available_usd | number | The sum of current_usd over every entry |
crypto_balances[].gateway | string | The gateway that holds the coins, for example oxapay or cryptomus |
crypto_balances[].currency | string | Coin ticker in capitals |
crypto_balances[].crypto_received | number | Coins credited from orders |
crypto_balances[].crypto_withdrawn | number | Coins in completed and processing withdrawals |
crypto_balances[].crypto_pending | number | Coins in pending withdrawals |
crypto_balances[].crypto_available | number | Coins you can withdraw now. Never below 0 |
crypto_balances[].current_price | number | The USD price Shoplio holds for the coin at the time of the call |
crypto_balances[].current_usd | number | crypto_available at current_price. An estimate, not a payout quote |
crypto_balances[].historical_usd | number | The 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.