GET /v1/balance_transactions餘額接口 回答餘額是多少,這個接口回答它是怎麼變成這樣的。手續費、退款、拒付、提現各記一行,加起來就是餘額的變化。
篩選參數
除 通用列表參數 外:
| 參數 | 説明 |
|---|---|
type | 變動類型,見下表 |
reference_id | 觸發這筆流水的訂單號 / 退款號 / 拒付號 / 提現號 |
currency | 三位 ISO 4217 代碼 |
變動類型
| type | 含義 | 金額方向 |
|---|---|---|
opening_balance | 錢包開戶資金(僅沙箱:每個幣種 5,000.00;正式錢包從 0 開始) | + |
payment_credit | 收單入賬(訂單原始金額) | + |
fee_debit | 平台收單手續費 | − |
refund_freeze | 退款受理,資金轉入凍結 | − |
refund_debit | 通道確認退款,真實扣賬 | − |
refund_unfreeze | 退款被拒,凍結資金退回 | + |
dispute_freeze | 拒付開案,爭議金額凍結 | − |
dispute_unfreeze | 拒付勝訴或被撤銷,凍結資金退回 | + |
dispute_debit | 拒付敗訴,爭議金額扣賬 | − |
dispute_fee | 拒付處理費 | − |
payout_freeze | 發起提現,金額凍結 | − |
payout_unfreeze | 提現駁回或失敗,凍結資金退回 | + |
payout_success | 提現轉賬完成,從凍結中扣賬 | − |
payout_fee | 提現手續費 | − |
manual_adjustment | 平台人工調賬(僅正式環境):糾正記賬錯誤或登記補繳欠款,description 寫明原因;須經兩位平台管理員複核後才生效 | ± |
sandbox_top_up | 僅沙箱:在商戶後台「資金賬戶」頁點「補充測試資金」,把可用餘額補回開戶金額 5,000.00,本行金額為補足的差額 | + |
沙箱錢包開戶時就記一行 opening_balance,讓新接入可以直接演練退款和提現;它也是賬本能從 0 解釋到當前餘額的起點,對賬時不要把它當成異常。測試資金用完後可以自助補充,同樣會記一行 sandbox_top_up,賬本始終能解釋餘額。
一筆成功支付會產生兩行:payment_credit(訂單全額)加 fee_debit(手續費),差額就是入賬淨額。
請求
curl -G "https://api.kukopay.com/v1/balance_transactions" \
-H "X-Api-Key: kuko_live_你的密鑰" \
-d limit=100 \
-d "created[gte]=2026-09-20T00:00:00Z"響應
{
"object": "balance_transaction",
"id": "LED_8f2c4a1e-...-CRT",
"merchant_id": "mch_a1b2c3d4e5",
"type": "payment_credit",
"currency": "USD",
"amount": 2990,
"balance_before": 120000,
"balance_after": 122990,
"reference_id": "TRD_9F3A2C7E...",
"description": "收單交易入賬: Pro 年度訂閲 (外單號: ORD_20260921_0001)",
"mode": "live",
"created_at": "2026-09-21T08:31:12.114Z"
}balance_before / balance_after 記錄的是可用餘額。凍結類變動(refund_freeze、dispute_freeze、payout_freeze)會讓可用餘額下降、凍結餘額上升;從凍結中扣賬時可用餘額不變,所以這兩個值相等。
amount 是有符號整數,支出為負。把某段時間的所有 amount 相加,結果就等於這段時間可用餘額的淨變化。
CSV 導出
curl -G "https://api.kukopay.com/v1/balance_transactions" \
-H "X-Api-Key: kuko_live_你的密鑰" \
-d format=csv \
-d "created[gte]=2026-09-01T00:00:00Z" \
-d "created[lte]=2026-09-30T23:59:59Z" \
-o 2026-09-對賬.csv