Tài liệu CodeRent
Chào mừng bạn đến với hệ thống Tài liệu CodeRent. API này cho phép bạn kết nối tra cứu số dư và lịch sử ngân hàng hoàn toàn tự động.
Hệ thống hỗ trợ 2 mô hình tích hợp: Khách lẻ và Đại lý (Reseller). Đối với site con sử dụng hình thức đại lý sẽ nhận được mức chiết khấu thuê bank cực cao.
Lưu ý bảo mật
API Token này có quyền truy cập dữ liệu của bạn. Tuyệt đối không chia sẻ cho bất kỳ ai hoặc để lộ trong mã nguồn phía client.
Hướng Dẫn
Thay vì mỗi khách hàng trên site con phải thuê 1 gói lẻ, Seller chỉ cần sở hữu 1 gói dịch vụ Full Bank để phục vụ toàn bộ khách hàng.
Bước 1: Seller thuê Gói Full Bank
Seller truy cập trang chủ hoặc dùng API Thuê gói để sở hữu gói có đầy đủ các ngân hàng cần thiết. Gói này được dùng làm nền tảng cho mọi khách hàng của site con.
Bước 2: Quản lý khách hàng trên Site con
Khi khách của site con bấm "Thuê", Seller tự trừ tiền khách trên DB của mình. Tuyệt đối không gọi lại API Thuê gói ở bước này để tránh bị ghi đè gói cũ.
Bước 3: Thêm Bank cho khách con
Sử dụng API /api/add-bank kèm Token của Seller. Lưu trữ lại
bank_token hệ thống trả về để biết bank đó thuộc về khách hàng nào trên
site con.
Bước 4: Tra cứu tập trung
Mọi yêu cầu tra cứu Lịch sử/Số dư của khách con đều dùng chung 1 Token Seller nhưng
khác bank_token. Hệ thống sẽ trả về đúng dữ liệu của khách đó.
USER_SITE_CON_ID | BANK_ID | SYSTEM_BANK_TOKEN để tra cứu chính xác.
Để thực hiện các yêu cầu thành công, bạn cần đảm bảo 2 điều kiện sau:
- Truyền tham số
tokenvào URL của yêu cầu. - Truyền Header
X-Domainchứa tên miền (domain) của website bạn đang tích hợp (ví dụ:domain.com).
Lấy danh sách các ngân hàng mà hệ thống đang hỗ trợ kết nối.
{
"status": "success",
"data": [
{
"name": "Ngân hàng TMCP Quân đội",
"code": "MB",
"short_name": "MBBank",
"image": "https://api.coderent.vn/assets/clients/images/mbbank.png"
},
{
"name": "Ngân hàng TMCP Á Châu",
"code": "ACB",
"short_name": "ACB",
"image": "https://api.coderent.vn/assets/clients/images/acb.png"
}
]
}
Kết nối tài khoản ngân hàng mới của bạn vào hệ thống để bắt đầu tra cứu tự động.
Lưu ý: Một số ngân hàng (VCB, OCB, TPBank) sẽ yêu cầu
thêm
bước xác minh OTP hoặc Captcha. Nếu API trả về status warning hoặc
captcha, hãy sử dụng endpoint Xác minh Banking để hoàn tất.
| Tham số | Loại | Mô tả |
|---|---|---|
| token* | string | Mã API của bạn |
| bank_code* | string | Mã ngân hàng (MB, ACB, VCB, OCB, TPB, TCB, SEAB, VPB, MSB, EIB, thesieure, VTLMONEY) |
| username* | string | Tên đăng nhập ngân hàng |
| password* | string | Mật khẩu ngân hàng |
| number_account | string | Số tài khoản (Nếu ngân hàng yêu cầu) |
Sử dụng endpoint này khi bước Thêm Banking yêu cầu xác thực bổ sung.
| Tham số | Loại | Mô tả |
|---|---|---|
| token* | string | Mã API của bạn |
| bank_code* | string | Mã ngân hàng (VCB, OCB, TPB, ...) |
| username* | string | Tên đăng nhập đã dùng ở bước 1 |
| otp | string | Mã OTP (Bắt buộc cho VCB, OCB) |
| captcha | string | Mã Captcha đã giải (Bắt buộc cho TPBank) |
Gỡ bỏ hoàn toàn một liên kết ngân hàng khỏi hệ thống.
| Tham số | Loại | Mô tả |
|---|---|---|
| token* | string | Mã API của bạn |
| bank_code* | string | Mã ngân hàng (MB, ACB, VCB, TPB, OCB, MSB, VPB, SEAB, BIDV, EIB, ZALOPAY, THESIEURE, VTLMONEY) |
| bank_token* | string | Mã token định danh của ngân hàng (Lấy từ Tra cứu tài khoản) |
Thực hiện trừ tiền và khởi tạo cấu hình Cron Job mới.
| Tham số | Loại | Mô tả |
|---|---|---|
| token* | string | Mã API của bạn |
| url* | string | Đường dẫn (URL) cần được gọi bởi Cron Job |
| interval_seconds* | int | Chu kỳ chạy (giây), tối thiểu là 1 |
| duration_days* | int | Số ngày thuê, tối thiểu là 30 |
{
"status": "success",
"message": "Đăng ký thuê Cron thành công!"
}
Lấy toàn bộ dữ liệu cấu hình và trạng thái các Cron Job bạn đang có.
| Tham số | Loại | Mô tả |
|---|---|---|
| {token}* | string | Mã API của bạn |
{
"status": "success",
"data": [
{
"id": 1,
"url": "https://example.com/api/cron",
"interval_seconds": 60,
"status": "active",
"call_count": 150,
"expired_at": "2026-04-09 18:00:00"
}
]
}
Lấy thông tin tổng quan về tài khoản, số dư, hạn mức và danh sách ngân hàng đã kết nối.
| Tham số | Loại | Mô tả |
|---|---|---|
| token* | string | Mã API của bạn |
{
"status": "success",
"data": {
"username": "manh_dev",
"avatar": "http://127.0.0.1:8000/assets/images/user.png",
"balance": 500000,
"total_deposit": 2000000,
"total_used": 1500000,
"banks": {
"mbbank": 2,
"acb": 1,
"vcb": 0,
"ocb": 0,
"tpbank": 1,
"tcb": 0,
"msb": 0,
"eximbank": 0,
"bidv": 0,
"vpbank": 0,
"seabank": 0,
"viettelmoney": 0,
"zalopay": 0,
"thesieure": 0
},
"total_banks": 4
}
}