查詢客戶點數額度

View as Markdown
依客戶序號查詢目前的點數額度水位。查無此客戶(含跨租戶命中)一律回傳 404 company_not_found,兩種情況無法從回應內容區分。客戶存在但從未同步過點數時仍是 200,不是 404:balance 為 0、enabled 為 true(點數側「缺列即視為啟用」,與合約額度側的預設相反,見合約額度家族說明)、memo 為空字串、updatedAt 為 null。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Path parameters

idlongRequired

要查詢的客戶序號,即 CompanyResponse 的 id。查無此客戶或屬於其他租戶時,一律回傳 404 company_not_found。

Response

OK
companyIdlongOptional

客戶序號,即 CompanyResponse 的 id。

companyOuterSysCodestring or nullOptional

這個客戶的 ERP 代碼,即 outerSysCode,方便你端核對。

balancedoubleOptional

目前的絕對點數餘額,數值(小數 2 位),由批次同步端點寫入的最新值。

pendingUseddoubleOptional

已下單但尚未出貨、佔用中的點數保留量。

availableBalancedoubleOptional

目前還能使用的點數,等於 balance 減去 pendingUsed;可能為負,代表保留量已經超過餘額,刻意不夾在 0,呈現層需要自行處理。

enabledbooleanOptional

是否納入額度管控。⚠️ 目前只是回報,不是卡控:下單時真正檢查點數是否足夠的流程不會讀這個欄位,把它設成 false 不會讓這個客戶的點數變成無上限。與合約額度側的同名欄位不對稱——那邊的 enabled 真的會被下單流程拿來決定是否放行,這邊目前不會,詳見批次同步端點的說明。

memostring or nullOptional

備註,最長 200 字元,由批次同步端點寫入。

updatedAtdatetime or nullOptional

最後一次同步的時間;從未同步過時為 null。

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error