Developer guide

Bắt đầu với API Bank

Từ token đầu tiên đến request lấy giao dịch: các bước tối thiểu để kết nối hệ thống của bạn với Thuê API Bank.

Tổng quan

API giao dịch hoạt động thế nào?

Mỗi tài khoản ngân hàng sau khi thêm thành công sẽ có token truy cập. Ứng dụng của bạn gọi endpoint tương ứng để lấy danh sách giao dịch mới nhất và sử dụng các trường số tiền, nội dung, mã giao dịch để xử lý nghiệp vụ.

Base URLhttps://thueapibank.vn

Xác thực bằng token

Token nằm ở phần quản lý tài khoản ngân hàng. Tùy phiên bản, token được đặt ở cuối đường dẫn. Hãy gọi API từ máy chủ của bạn và không để token xuất hiện trong mã JavaScript phía trình duyệt.

Lưu ý bảo mật

Không đưa token vào Git, ảnh chụp màn hình, log công khai hoặc URL theo dõi của bên thứ ba. Tạo token mới ngay khi nghi ngờ bị lộ.

Request đầu tiên

GEThttps://thueapibank.vn/historyapivcbv2/YOUR_TOKEN
curl --request GET \
  "https://thueapibank.vn/historyapivcbv2/YOUR_TOKEN" \
  --header "Accept: application/json"

Cấu trúc phản hồi

Tên trường chi tiết có thể khác theo ngân hàng, nhưng dữ liệu cốt lõi luôn gồm trạng thái và danh sách giao dịch.

TrườngKiểuÝ nghĩa
statusstringTrạng thái xử lý request.
transactionsarrayDanh sách giao dịch tìm thấy.
transactionIDstringMã tham chiếu giao dịch.
amountnumberSố tiền của giao dịch.
descriptionstringNội dung chuyển khoản.
typestringIN cho tiền vào, OUT cho tiền ra.

Mã trạng thái cần xử lý

200Thành côngĐọc và lưu giao dịch chưa xử lý.

401Token không hợp lệKiểm tra token hoặc tạo lại token.

404Không tìm thấyKiểm tra đường dẫn và phiên bản API.

429Quá nhiều requestChờ theo Retry-After và dùng backoff.

5xxLỗi tạm thờiThử lại có giới hạn và ghi log để đối soát.

Chọn tài liệu ngân hàng

Xem toàn bộ ngân hàng hỗ trợ