Bỏ qua để đến nội dung

Số dư

~4 phút đọc

Số dư báo cáo (từ ngân hàng/sao kê) tách khỏi số dư tính toán (từ giao dịch).

MethodPathTóm tắtQuyềnNhóm tốc độTương tác
GET/v1/balancesSố dư của các tài khoảnaccount.readreadScalar
GET/v1/bank-accounts/{id}/balanceSố dư của một tài khoảnaccount.readreadScalar

Số dư của các tài khoản

Số dư từng tài khoản trong phạm vi, phân trang theo con trỏ.

Quyền: account.read Scope: balances:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách số dư. — BalanceList, application/json
  • Mã lỗi riêng của endpoint: invalid_cursor
TênVị tríBắt buộcKiểuMô tả
limitqueryKhôngintegerSố phần tử mỗi trang (1–100, mặc định 20).
cursorqueryKhôngCursorCon trỏ phân trang mờ (cur_…) lấy từ next_cursor; không tự tạo hay sửa.
curl -sS -X GET "https://api.dongtien.pro/v1/balances" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Số dư của một tài khoản

Quyền: account.read Scope: balances:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Số dư. — Balance, application/json
  • Mã lỗi riêng của endpoint: resource_not_found
TênVị tríBắt buộcKiểuMô tả
idpathCóAccountIdMã tài khoản ngân hàng (acc_…).
curl -sS -X GET "https://api.dongtien.pro/v1/bank-accounts/$ID/balance" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

TrườngKiểuBắt buộcMô tả
dataBalance[]Có—
data[].account_idAccountIdCó—
data[].as_ofstringCóThời điểm tính của phản hồi này.
data[].computedobject | nullCóSố dư tính từ mốc neo + giao dịch đã xác thực; null nếu chưa có mốc neo.
data[].differenceinteger | nullCóreported − computed khi có cả hai.
data[].evidenceobjectCó—
data[].objectstringCóGiá trị: balance.
data[].reportedobject | nullCóSố dư do ngân hàng/sao kê báo cáo; null nếu chưa nhận được.
data[].trustBalanceChainTrustCóGiá trị: consistent, mismatch, gap_suspected, unchecked.
has_morebooleanCó—
next_cursorstring | nullCóCon trỏ trang kế; null khi hết dữ liệu.
objectstringCóGiá trị: list.
TrườngKiểuBắt buộcMô tả
account_idAccountIdCó—
as_ofstringCóThời điểm tính của phản hồi này.
computedobject | nullCóSố dư tính từ mốc neo + giao dịch đã xác thực; null nếu chưa có mốc neo.
computed.amountVndCó—
computed.as_ofTimestampCó—
differenceinteger | nullCóreported − computed khi có cả hai.
evidenceobjectCó—
evidence.anchor_as_ofTimestamp | nullCó—
evidence.anchor_statestring | nullCóGiá trị: ok, mismatch, gap_suspected.
evidence.transactions_since_anchorintegerCó—
objectstringCóGiá trị: balance.
reportedobject | nullCóSố dư do ngân hàng/sao kê báo cáo; null nếu chưa nhận được.
reported.amountVndCó—
reported.as_ofTimestampCó—
reported.sourcestringCóNguồn của số dư báo cáo. Giá trị: openapi, statement, sms_verified, sms_provisional, computed.
trustBalanceChainTrustCóGiá trị: consistent, mismatch, gap_suspected, unchecked.

Lưu ý về từ "đã xác thực": đây là xác thực nguồn, không phải ngân hàng xác nhận quyết toán.