Tổng quan

bankHub.dev cung cấp giải pháp Open banking của các ngân hàng Việt Nam

Định dạng kết quả

Các yêu cầu sẽ trả về dạng JSON, và một vài trường hợp sẽ trả về form-encoded. Về thời gian(Date) sẽ trả về kiểu ISO 8601, còn với thuộc tính string sẽ là UTF-8.

Phiên bản của API

API sẽ dựa vào trường X-BankHub-Api-Version được thiết lập ở headers của mỗi lần gọi API, để lựa chọn phiên bản API phù hợp, nếu không sẽ lấy phiên bản mới nhất, xem chi tiết

Rate Limits

Để đảm bảo dịch vụ ổn định, bankHub API xác định giới hạn truy cập trên mỗi lần Ứng dụng gọi.

Nếu thực hiện quá nhiều yêu cầu cùng một lúc hoặc nằm trong khoảng giới hạn của từng Ứng dụng trên BankHub, thì bạn sẽ nhận một kết quả HTTP là 429 Too Many Requests. Bạn có thể liên hệ bankHub để biết thêm chi tiết.

Xử lý sự cố

Với mỗi yêu cầu bankHub sẽ trả về trường requestId, đây là trường định danh của mỗi yêu cầu, với mục địch xử lý các sự cố liên quan tới các lỗi mà bạn không muốn mà muốn kiểm tra nguyên nhân.

Xác thực

Mỗi ứng dụng được tạo từ bankHub Console sẽ có 2 giá trị là: client-id và secret-key.

bankHub API sử dụng Mã truy cập(accessToken) để xác thực các yêu cầu. accessToken sẽ được thiết lập với Authorization ở Headers. Với mỗi lần yêu cầu với mã truy cập hết hạn thì bạn sẽ nhận được một kết quả với HTTP Status Code là 401.

Phạm vi truy cập

Phạm vi truy cập sẽ được thiết lập trên mỗi Ứng dụng, và sau đó sẽ dựa vào grant khởi tạo phạm vi là gì, để hạn chế việc rủi ro trên mỗi lần phân quyền.

Với mỗi lần bạn tạo một grant(phân quyền), bạn sẽ truyền tương ứng trường scope để giới hạn phạm vi truy cập của phân quyền này.

Scope	Mô tả
identity	Xem thông tin định danh bao gồm: tên, số căn cước công dân, ngày sinh, số điện thoại, email
transaction	Xem lịch sử giao dịch của tài khoản