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

Gói & sử dụng

~15 phút đọc

Gói dịch vụ, đo lường giao dịch, thanh quota, trần chi tiêu, hoá đơn và nạp credit dịch vụ.

MethodPathTóm tắtQuyềnNhóm tốc độTương tác
GET/v1/billing/creditSố dư credit dịch vụ và lịch sử biến độngbilling.readreadScalar
POST/v1/billing/credit:topup-qrTạo mã VietQR nạp credit dịch vụbilling.writewriteScalar
GET/v1/billing/infoThông tin xuất hoá đơn tài chínhbilling.readreadScalar
PUT/v1/billing/infoCập nhật thông tin xuất hoá đơn tài chínhbilling.writewriteScalar
GET/v1/billing/invoicesDanh sách hoá đơn gói dịch vụbilling.readreadScalar
POST/v1/billing/invoices/{id}:pay-qrTạo mã VietQR thanh toán hoá đơn góibilling.writewriteScalar
GET/v1/billing/meterThanh đo hạn mức sử dụng kỳ hiện tạibilling.readreadScalar
GET/v1/billing/planThông tin gói cước và hạn mức hiện tạibilling.readreadScalar
GET/v1/billing/spend-capXem trần chi tiêu tự đặtbilling.readreadScalar
PUT/v1/billing/spend-capCập nhật trần chi tiêu tự đặtbilling.writewriteScalar
GET/v1/billing/usageChi tiết số lượng giao dịch sử dụngbilling.readreadScalar
GET/v1/public/plansBảng giá và tính năng các gói công khaiCông khai, không cần khoáreadScalar

Số dư credit dịch vụ và lịch sử biến động

Tra cứu số dư credit dịch vụ hiện tại và sổ cái biến động (nạp tiền, trừ hoá đơn, hoàn trả).

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Số dư credit dịch vụ. — ServiceCreditBalanceResponse, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/credit" \
-H "Authorization: Bearer $DT_API_KEY"

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

Tạo mã VietQR nạp credit dịch vụ

Tạo mã VietQR nạp trước credit dịch vụ để tự động trừ vào các kỳ hoá đơn tiếp theo. Lưu ý: credit không phải ví tiền, không thể rút.

Quyền: billing.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: TopupQrRequest (application/json)
  • Phản hồi thành công 200: Thông tin mã VietQR nạp credit. — TopupQrResponse, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/billing/credit:topup-qr" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount_vnd": 4500000
}'

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

Thông tin xuất hoá đơn tài chính

Thông tin doanh nghiệp (MST, tên công ty, địa chỉ, email nhận hoá đơn GTGT) để xuất hoá đơn điện tử.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Thông tin hoá đơn tài chính. — BillingInfo, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/info" \
-H "Authorization: Bearer $DT_API_KEY"

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

Cập nhật thông tin xuất hoá đơn tài chính

Cập nhật mã số thuế, tên công ty và email để nhận hoá đơn điện tử GTGT hợp lệ.

Quyền: billing.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: UpdateBillingInfo (application/json)
  • Phản hồi thành công 200: Thông tin hoá đơn tài chính đã cập nhật. — BillingInfo, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X PUT "https://api.dongtien.pro/v1/billing/info" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tax_id": "0312345678",
"company_name": "Công ty TNHH Thương mại Sao Việt",
"invoice_address": "25 Nguyễn Huệ, Phường Bến Nghé, Quận 1, TP. Hồ Chí Minh",
"invoice_email": "ketoan@saoviet.vn",
"contact_name": "Nguyễn Thị Lan",
"contact_email": "lan.nguyen@saoviet.vn"
}'

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

Danh sách hoá đơn gói dịch vụ

Danh sách hoá đơn hàng tháng của tổ chức (mã DTP-INV-YYMM), trạng thái thanh toán và mã nội dung.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách hoá đơn. — BillingInvoiceList, 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.
statequeryKhôngstringLọc theo trạng thái hoá đơn.
curl -sS -X GET "https://api.dongtien.pro/v1/billing/invoices" \
-H "Authorization: Bearer $DT_API_KEY"

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

Tạo mã VietQR thanh toán hoá đơn gói

Tạo mã chuyển khoản VietQR chuẩn EMVCo có gắn mã nội dung DTP… độc nhất. Hiệu lực 15 phút, tự gạch nợ sau khi tiền về.

Quyền: billing.write
  • Nhóm tốc độ: write
  • Phản hồi thành công 200: Thông tin mã VietQR thanh toán hoá đơn. — PayQrResponse, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóBillingInvoiceIdMã hoá đơn thanh toán (bin_…).
curl -sS -X POST "https://api.dongtien.pro/v1/billing/invoices/$ID:pay-qr" \
-H "Authorization: Bearer $DT_API_KEY"

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

Thanh đo hạn mức sử dụng kỳ hiện tại

Đo lường số giao dịch đã xác thực trong tháng theo giờ VN, hạn mức miễn phí, dự kiến cuối tháng và trần chi tiêu.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Thông số đo lường hiện tại. — BillingMeter, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/meter" \
-H "Authorization: Bearer $DT_API_KEY"

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

Thông tin gói cước và hạn mức hiện tại

Chi tiết gói cước đang áp dụng, bảng giá bậc luỹ tiến và các quyền hạn mức.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Thông tin gói cước. — CurrentPlanResponse, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/plan" \
-H "Authorization: Bearer $DT_API_KEY"

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

Xem trần chi tiêu tự đặt

Hạn mức trần do khách tự đặt để tự bảo vệ chi phí, tránh vượt dự toán ngoài ý muốn.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Hạn mức trần chi tiêu hiện tại. — SpendCap, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/spend-cap" \
-H "Authorization: Bearer $DT_API_KEY"

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

Cập nhật trần chi tiêu tự đặt

Cập nhật mức trần chi tiêu. Chạm trần không chặn nhận giao dịch và webhook, chỉ tạm dừng AI nền tảng và lệnh xuất mới.

Quyền: billing.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: UpdateSpendCap (application/json)
  • Phản hồi thành công 200: Trần chi tiêu đã lưu. — SpendCap, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X PUT "https://api.dongtien.pro/v1/billing/spend-cap" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"spend_cap_vnd": 4500000
}'

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

Chi tiết số lượng giao dịch sử dụng

Phân bổ số giao dịch đã xác thực theo ngày, kênh nguồn hoặc theo từng công ty.

Quyền: billing.read Scope: billing:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Thống kê chi tiết lượng giao dịch. — UsageBreakdownResponse, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
TênVị tríBắt buộcKiểuMô tả
fromqueryKhôngstringTừ ngày YYYY-MM-DD.
toqueryKhôngstringĐến ngày YYYY-MM-DD.
group_byqueryKhôngstringNhóm theo ngày, nguồn dữ liệu hoặc công ty thành viên.
curl -sS -X GET "https://api.dongtien.pro/v1/billing/usage" \
-H "Authorization: Bearer $DT_API_KEY"

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

Bảng giá và tính năng các gói công khai

Danh sách các gói dịch vụ, hạn mức quota miễn phí, đơn giá luỹ tiến theo giao dịch và các quyền hạn mức công khai. Không yêu cầu đăng nhập, cache 5 phút.

Quyền: Công khai, không cần khoá
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Bảng giá công khai các gói cước. — PublicPlansResponse, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/public/plans"

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

TrườngKiểuBắt buộcMô tả
balance_vndintegerCóSố dư credit dịch vụ hiện có (không phải ví tiền, không rút được).
entriesServiceCreditEntry[]Có—
entries[].amount_vndintegerCóBiến động VND (dương = cộng, âm = trừ).
entries[].balance_after_vndintegerCóSố dư sau biến động (luôn >= 0).
entries[].created_atTimestampCó—
entries[].descriptionstringCó—
entries[].idstringCóMã dòng sổ cái credit.
entries[].kindstringCóGiá trị: topup, invoice_deduct, overpay_credit, adjustment_credit, adjustment_debit, refund.
entries[].reference_idstring | nullCóMã tham chiếu (hoá đơn, topup, v.v.).
TrườngKiểuBắt buộcMô tả
amount_vndintegerCóSố tiền nạp (tối thiểu 50.000 ₫).
TrườngKiểuBắt buộcMô tả
amount_vndPositiveVndCó—
bank_accountBankAccountRecipientCó—
bank_account.account_namestringCóTên chủ tài khoản.
bank_account.account_nostringCóSố tài khoản nhận tiền.
bank_account.bank_namestringCóTên ngân hàng ngắn gọn.
bank_account.binstringCóMã BIN ngân hàng thụ hưởng (VietQR).
expires_atTimestampCó—
memo_codestringCóMã nội dung DTP…
qr_payloadstringCó—
topup_idstringCóMã giao dịch nạp credit.
TrườngKiểuBắt buộcMô tả
company_namestring | nullCóTên doanh nghiệp trên hoá đơn GTGT.
contact_emailstring (email) | nullCó—
contact_namestring | nullCó—
invoice_addressstring | nullCóĐịa chỉ nhận hoá đơn GTGT.
invoice_emailstring (email) | nullCóEmail nhận hoá đơn GTGT điện tử.
tax_idstring | nullCóMã số thuế doanh nghiệp.
TrườngKiểuBắt buộcMô tả
company_namestring | nullKhôngTên doanh nghiệp trên hoá đơn GTGT.
contact_emailstring (email) | nullKhông—
contact_namestring | nullKhông—
invoice_addressstring | nullKhôngĐịa chỉ nhận hoá đơn GTGT.
invoice_emailstring (email) | nullKhôngEmail nhận hoá đơn GTGT điện tử.
tax_idstring | nullKhôngMã số thuế doanh nghiệp.
TrườngKiểuBắt buộcMô tả
dataBillingInvoice[]Có—
data[].billed_countintegerCóSố giao dịch tính phí ngoài quota.
data[].codestringCóMã hoá đơn hiển thị, ví dụ DTP-INV-2610.
data[].created_atTimestampCó—
data[].credit_deducted_vndintegerCóCredit dịch vụ đã tự động trừ.
data[].due_atTimestamp | nullCó—
data[].idBillingInvoiceIdCó—
data[].memo_codestring | nullCóMã nội dung DTP… gắn với hoá đơn này.
data[].paid_atTimestamp | nullCó—
data[].periodstringCó—
data[].received_vndintegerCóSố tiền đã nhận qua VietQR.
data[].statestringCóGiá trị: accruing, open, paid, overdue, void, free_tier.
data[].subtotal_vndintegerCóTiền trước thuế: giá theo bậc (đã gồm VAT) trừ phần VAT tách ra.
data[].total_vndintegerCóTổng tiền còn phải thanh toán sau khi trừ credit: subtotal_vnd + vat_vnd - credit_deducted_vnd.
data[].tx_countintegerCóTổng giao dịch trong kỳ.
data[].updated_atTimestampCó—
data[].vat_invoice_refstring | nullCóSố hoá đơn GTGT điện tử (hoadon.pro).
data[].vat_issued_atTimestamp | nullCó—
data[].vat_percentintegerCóTỷ lệ VAT (%).
data[].vat_vndintegerCóTiền thuế VAT nằm trong giá theo bậc (subtotal_vnd + vat_vnd = giá theo bậc, VAT không cộng thêm).
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ả
amount_vndintegerCóSố tiền cần chuyển chính xác.
bank_accountBankAccountRecipientCó—
bank_account.account_namestringCóTên chủ tài khoản.
bank_account.account_nostringCóSố tài khoản nhận tiền.
bank_account.bank_namestringCóTên ngân hàng ngắn gọn.
bank_account.binstringCóMã BIN ngân hàng thụ hưởng (VietQR).
expires_atstringCóThời điểm hết hiệu lực thanh toán (15 phút).
invoice_idBillingInvoiceIdCó—
memo_codestringCóMã nội dung chuyển tiền DTP… chuẩn.
qr_data_urlstringKhôngẢnh QR định dạng data:image/png (nếu có).
qr_payloadstringCóChuỗi chuẩn VietQR EMV Co.
TrườngKiểuBắt buộcMô tả
cappedbooleanCótrue khi đã vượt trần chi tiêu.
estimated_fee_vndintegerCóƯớc tính phí phát sinh kỳ hiện tại (giá theo bậc, đã gồm VAT).
is_illustrativebooleanCótrue khi giá và phí còn gắn nhãn minh hoạ.
periodstringCóKỳ đo lường YYYY-MM (giờ VN).
projectedintegerCóDự kiến số giao dịch cuối tháng.
quotaintegerCóSố giao dịch miễn phí trong gói.
spend_cap_vndinteger | nullCóTrần chi tiêu do khách đặt (null = không đặt).
todayintegerCóSố giao dịch tính đến hiện tại trong ngày.
usedintegerCóSố giao dịch đã xác thực trong kỳ.
TrườngKiểuBắt buộcMô tả
descriptionstring | nullCó—
dunning_stagestringCóGiá trị: current, reminder_3d, reminder_7d, reminder_14d, suspended_30d.
is_illustrativebooleanCó—
limitsPlanLimitsCó—
namestringCó—
plan_keystringCóGiá trị: free, per_tx, enterprise, trial, internal.
statestringCóGiá trị: trial, active, overdue, suspended, closing.
tiersPlanTier[]Có—
tiers[].unit_vndintegerCóĐơn giá mỗi giao dịch trong bậc (VND).
tiers[].up_tointeger | nullCóHạn mức tối đa của bậc (null = không giới hạn).
trial_ends_atTimestamp | nullCó—
TrườngKiểuBắt buộcMô tả
spend_cap_vndinteger | nullCóHạn mức trần chi tiêu (null = không hạn chế).
TrườngKiểuBắt buộcMô tả
spend_cap_vndinteger | nullCóĐặt lại hạn mức trần chi tiêu VND (null để gỡ bỏ).
TrườngKiểuBắt buộcMô tả
itemsUsageBreakdownItem[]Có—
items[].company_idstringKhông—
items[].countintegerCó—
items[].dateDateKhông—
items[].sourcestringKhông—
periodstringCó—
total_countintegerCó—

Đối tượng khác của nhóm này (xem tài liệu tương tác): PublicPlansResponse

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.