API Tài khoản ngân hàng
Tài liệu về cách sử dụng API tài khoản ngân hàng thông qua OAuth2 trong SePay.
Giới thiệu
API tài khoản ngân hàng của SePay cho phép bạn truy vấn thông tin chi tiết về các tài khoản ngân hàng đã được thêm vào SePay. Bạn có thể lấy danh sách tài khoản, xem chi tiết từng tài khoản và tài khoản phụ liên kết với nó.
Để sử dụng API này, bạn cần có quyền
bank-account:readtrong phạm vi (scope) của Access Token.
Các Endpoints
API tài khoản ngân hàng cung cấp các endpoints sau:
GET/api/v1/bank-accounts- Lấy danh sách tất cả tài khoản ngân hàng
GET/api/v1/bank-accounts/{id}- Lấy thông tin chi tiết một tài khoản ngân hàng
GET/api/v1/bank-accounts/{id}/sub-accounts- Lấy danh sách tài khoản phụ của một tài khoản ngân hàng
Lấy danh sách tài khoản ngân hàng
GET
/api/v1/bank-accounts Authorization: Bearer {YOUR_ACCESS_TOKEN}
Endpoint này trả về danh sách tài khoản ngân hàng thuộc công ty của bạn.
Quyền yêu cầu
- Scope:
bank-account:read - Quyền người dùng: Tài khoản ngân hàng (Xem danh sách tài khoản)
- Scope:
Tham số truy vấn
Tên Loại Bắt buộc Mô tả pageinteger Không bắt buộc Số trang, bắt đầu từ 1limitinteger Không bắt buộc Số lượng kết quả trên mỗi trang
Lấy chi tiết tài khoản ngân hàng
GET
/api/v1/bank-accounts/{id} Authorization: Bearer {YOUR_ACCESS_TOKEN}
Endpoint này trả về thông tin chi tiết của một tài khoản ngân hàng dựa trên ID.
Quyền yêu cầu
- Scope:
bank-account:read - Quyền người dùng: Tài khoản ngân hàng (Xem chi tiết tài khoản)
- Scope:
Tham số đường dẫn
Tên Loại Bắt buộc Mô tả idinteger Bắt buộc ID của tài khoản ngân hàng
Lấy danh sách tài khoản phụ
GET
/api/v1/bank-accounts/{id}/sub-accountsAuthorization: Bearer {YOUR_ACCESS_TOKEN}
- Endpoint này trả về danh sách tài khoản phụ của một tài khoản ngân hàng.
- Quyền yêu cầu
- Scope:
bank-account:read - Quyền người dùng: Tài khoản ngân hàng (Xem danh sách tài khoản)
- Scope:
- Tham số đường dẫn
Tên Loại Bắt buộc Mô tả idinteger Bắt buộc ID của tài khoản ngân hàng - Tham số truy vấn
Tên Loại Bắt buộc Mô tả pageinteger Không bắt buộc Số trang, bắt đầu từ 1limitinteger Không bắt buộc Số lượng kết quả trên mỗi trang
Mã lỗi
- Dưới đây là các mã lỗi có thể gặp khi sử dụng API tài khoản ngân hàng:
| Mã Http | Mã lỗi | Mô tả |
|---|---|---|
| 401 | unauthorized | Token không hợp lệ hoặc hết hạn |
| 403 | forbidden | Không có quyền truy cập vào tài nguyên này |
| 404 | resource_not_found | Tài khoản ngân hàng không tồn tại |
Bước tiếp theo
- Tiếp theo, hãy tìm hiểu về API Giao dịch để lấy thông tin về các giao dịch liên quan đến tài khoản ngân hàng.