商戶餘額查詢
通過本介面可即時查詢當前商戶在 SureLink 網關中的數位資產(USDT)帳本餘額,包括可用於代付或提幣的可用餘額、正在處理中的凍結資金以及帳戶總資產。
1. 查詢商戶餘額
GET /api/v1/balance
請求頭 (Headers)
需攜帶標準 HMAC 鑑權請求頭(X-Api-Key、X-Timestamp、X-Nonce、X-Signature)。
由於是 GET 請求,待簽名源串為: $$\text{Signing String} = \text{X-Timestamp} + \text{"."} + \text{X-Nonce} + \text{"."}$$
請求參數
無(商戶身份完全由請求頭中的 API Key 與簽名解析確定)。
請求範例
bash
curl -X GET "https://api-sandbox.surelink.io/api/v1/balance" \
-H "X-Api-Key: mch_key_your_api_key" \
-H "X-Timestamp: 1715000000000" \
-H "X-Nonce: 9f8e7d6c5b4a392817263544a1b2c3d4" \
-H "X-Signature: c8b9...f01"typescript
import { sendSignedRequest } from './signer';
const balance = await sendSignedRequest({
apiKey: 'mch_key_...',
apiSecret: 'sec_...',
method: 'GET',
url: 'https://api-sandbox.surelink.io/api/v1/balance'
});
console.log('可用餘額:', balance.available);
console.log('凍結金額:', balance.frozen);
console.log('帳戶總額:', balance.total);python
from signer import make_signed_request
balance = make_signed_request(
api_key="mch_key_...",
api_secret="sec_...",
method="GET",
url="https://api-sandbox.surelink.io/api/v1/balance"
)
print(f"可用: {balance['available']}, 凍結: {balance['frozen']}, 總計: {balance['total']}")回應說明 (Response)
- HTTP 狀態碼:
200 OK
json
{
"merchantId": "3b2e5a7d-8f90-4c12-9e34-5a6b7c8d9e0f",
"currency": "USDT",
"available": "8500.500000",
"frozen": "1200.000000",
"total": "9700.500000"
}返回欄位描述
| 欄位 | 類型 | 說明 |
|---|---|---|
merchantId | string | 當前認證商戶的唯一 ID |
currency | string | 結算資產符號,固定為 'USDT' |
available | string | 可用餘額(保留 6 位小數),可自由用於發起代付出金或鏈上提幣 |
frozen | string | 凍結金額(保留 6 位小數),正在進行中的代付訂單或爭議掛起資金 |
total | string | 帳戶總額(保留 6 位小數),即 available + frozen |
