Sản lượng và trừ lượt

Mỗi lần xác thực có kết luận trừ 1 lượt từ ví sản lượng của đơn vị sở hữu ứng dụng.

Ví của đơn vị

Mỗi đơn vị có một ví sản lượng. VTS cấp sản lượng cho đơn vị gốc. Đơn vị gốc có thể chia cho chi nhánh trực tiếp và thu hồi lại.

Ứng dụng thuộc đơn vị nào thì trừ ví của đơn vị đó

Ví không dùng chung với đơn vị cấp trên. Nếu ví không đủ, API trả 402 QUOTA_INSUFFICIENT kể cả khi đơn vị cấp trên còn lượt.

Khi nào trừ lượt

Kết quả	Trừ lượt
200 với result: VALID	Có, 1 lượt
200 với result: INVALID	Có, 1 lượt
Response có error khác null (4xx, 5xx)	Không
Hệ thống xác thực lỗi, không phản hồi hoặc không xử lý được dữ liệu	Không Lượt tạm giữ được hoàn lại

Khi nhận request, hệ thống tạm giữ 1 lượt rồi gửi đi xác thực. Có kết luận thì trừ lượt đó. Có lỗi thì hoàn lại. Vì vậy trong lúc request đang chạy, balance có thể có phần reserved.

Response có kết luận kèm data.billing gồm quota_type, charged và balance_after.

Xem số dư

curl -sS "$EVERIFY_BASE_URL/balance" -H "X-API-Key: $EVERIFY_API_KEY"

{
  "request_id": "req_01JBF8...",
  "data": {
    "enterprise_code": "VPCC-DA",
    "balances": [
      {
        "quota_type": "eid_verify",
        "name": "Xác thực eID",
        "total_in": 10000,
        "total_out": 0,
        "used": 5001,
        "reserved": 0,
        "balance": 4999
      }
    ]
  },
  "error": null
}

Trường	Ý nghĩa
balance	Số lượt còn dùng được
reserved	Số lượt đang tạm giữ cho request chưa xong
used	Số lượt đã dùng
total_in, total_out	Tổng lượt đã vào và đã ra khỏi ví. Xem Đối soát sản lượng

Lịch sử giao dịch

GET /transactions trả các giao dịch của ứng dụng đang gọi, tối đa 100 mục mỗi trang. Thêm scope=enterprise để xem mọi ứng dụng của đơn vị. Lọc theo from, to, status, quota_type, product, client_ref. Lấy trang kế bằng cursor.

curl -sS "$EVERIFY_BASE_URL/transactions?limit=20" -H "X-API-Key: $EVERIFY_API_KEY"

Dùng client_ref để đối chiếu với mã giao dịch phía bạn. Cách đối soát theo tháng xem Đối soát sản lượng.