Lấy số dư

Đường dẫn

• URL: /api/v1/get-balance
• Method: POST
• Mô tả: Lấy số dư.

Chuỗi

Request

Bảng Request

Tham số	Loại dữ liệu	Bắt buộc	Mô tả
request_id	string(50)	Có	Mã duy nhất tương ứng với một request tải lên. Định dạng được đề xuất như sau: MerchantCode + BK + YYYYMMDD + UniqueId
request_time	string(19)	Có	Thời gian gửi request từ Merchant, định dạng: YYYY-MM-DD HH:MM:SS
merchant_code	string(20)	Có	Mã merchant được định nghĩa trong hệ thống Baokim. Mã này sẽ được gửi cho merchant trong quá trình tích hợp
currency_code	string(20)	Không	Mã tiền tệ (Ví dụ: VND, USD, ...). Nếu bạn muốn kiểm tra tất cả số dư, gửi null

Ví dụ Request

{
  "request_id": "BK20231106",
  "request_time": "2024-11-06 10:15:30",
  "merchant_code": "MERCHANT1234",
  "currency_code": null
}

Response

Bảng Response

Tham số	Loại dữ liệu	Bắt buộc	Mô tả
response_code	int(4)	Có	Mã lỗi từ Baokim theo Bảng mã lỗi
response_message	string(200)	Có	Mô tả mã lỗi từ Baokim theo Bảng mã lỗi
merchant_code	string(20)	Có	Mã merchant được Baokim cung cấp trước khi tích hợp
data	Array of Objects	Có	Danh sách số dư

Cấu trúc mảng Data (Bên trong data)

Tham số	Loại dữ liệu	Mô tả
currency_code	string(20)	Mã tiền tệ (Ví dụ: VND, USD, ...)
available_balance	decimal(18,2)	Số dư khả dụng
holding_balance	decimal(18,2)	Số dư bao gồm các giao dịch bị tạm ngừng
estimated_balance	decimal(18,2)	Số dư bao gồm tất cả các giao dịch của bạn

Ví dụ JSON Response

{
  "response_code": 200,
  "response_message": "Success",
  "merchant_code": "MERCHANT1234",
  "data": [
    {
      "currency_code": "VND",
      "available_balance": 10000000.00,
      "holding_balance": 0.00,
      "estimated_balance": 12000000.00
    },
    {
      "currency_code": "USD",
      "available_balance": 2500.00,
      "holding_balance": 0.00,
      "estimated_balance": 2500.00
    }
  ]
}

Mã lỗi

Mã Response	Thông báo Response
200	Success
99	Pending
11	Failed
101	System Error
110	Merchant code invalid
120	Invalid signature
422	Validation Error