Nhà phát triển

GET/v3/getbalance

Tra cứu số dư tài khoản

Tra cứu số dư, đơn vị tiền tệ và điều khoản thanh toán đã lưu của tài khoản API của bạn.

Trên trang này
  1. Yêu cầu
  2. Phản hồi
  3. Lỗi và cách sử dụng

Tra cứu số dư, đơn vị tiền tệ và giá trị điều khoản thanh toán của tài khoản được xác định bằng thông tin xác thực API của bạn. Đây là thao tác tra cứu số dư; thao tác này không nạp tiền hay đặt đơn hàng.

Yêu cầu

Sử dụng thông tin xác thực API ở phía máy chủ qua HTTPS. Các ví dụ đọc thông tin xác thực từ biến môi trường; chúng không chứa thông tin xác thực có thể sử dụng thực tế. Kiểm tra status.code trong phần thân JSON cũng như trạng thái HTTP. Các trình xử lý cũ này không phải lúc nào cũng đặt trạng thái lỗi HTTP khi xảy ra lỗi ứng dụng.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

Không yêu cầu tham số đường dẫn, truy vấn hay phần thân.

Phản hồi

Đây là cấu trúc phản hồi minh họa, không phải dữ liệu tài khoản hay báo giá hiện tại.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
Các trường trong phản hồi số dư
TrườngÝ nghĩa
balanceSố dư tài khoản đã lưu. Giữ nguyên độ chính xác thập phân khi xử lý các giá trị tiền tệ.
currencyGiá trị đơn vị tiền tệ được lưu cho tài khoản này.
termsGiá trị điều khoản thanh toán đã lưu của tài khoản. Trình xử lý không liệt kê hay chuẩn hóa giá trị này; đừng cho rằng ví dụ bao gồm tất cả các giá trị có thể có.

Lỗi và cách sử dụng

Khi xác thực thất bại, phản hồi xác thực dùng chung của API được sử dụng. Trình xử lý này không định nghĩa lỗi riêng cho trường hợp thiếu số dư và cũng không có cơ chế phân trang. Số dư được trả về không có nghĩa là tiền đã được giữ chỗ và không bảo đảm rằng một đơn hàng được đặt sau đó sẽ thành công.