Tạo Deeplink
Quy trình
Vị trí trong luồng nghiệp vụ: Bước chính — MERCHANT gọi API này sau khi người dùng đã chọn ngân hàng, để lấy deeplink_url điều hướng người dùng vào App ngân hàng.
- MERCHANT gọi API này để yêu cầu tạo deeplink theo Ngân hàng người dùng chọn thanh toán.
Thông tin API
Method: POST
URL: /b2b/core/api/ext/deeplink/create
Request
Bảng tham số chính
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | request_id | String(100) | ✅ | ID duy nhất ứng với mỗi Request từ MERCHANT sang Baokim |
| 2 | request_time | String(20) | ✅ | Thời gian gửi Request. Format: YYYY-MM-DD H:i:s |
| 3 | master_merchant_code | String(50) | ✅ | Mã định danh duy nhất cho master merchant |
| 4 | sub_merchant_code | String(50) | ✅ | Mã định danh duy nhất cho sub merchant |
| 5 | deeplink_bank_code | String(20) | ✅ | Mã App Ngân hàng tạo deeplink |
| 6 | bank_code | String(20) | ✅ | Mã Ngân hàng của người nhận tiền |
| 7 | account_number | String(100) | ✅ | Số tài khoản nhận tiền |
| 8 | account_name | String(255) | ✅ | Tên tài khoản nhận tiền |
| 9 | amount | Number | ✅ | Số tiền chuyển |
| 10 | note | String(50) | ✅ | Nội dung chuyển tiền |
| 11 | redirect_url | String(255) | ✅ | URL điều hướng về App của Merchant sau khi thanh toán |
Ví dụ Request
{
"request_id": "MERCHANT050015588AXE014",
"request_time": "2025-08-11 14:41:00",
"master_merchant_code": "MASTER_MERCHANT",
"sub_merchant_code": "SUB_MERCHANT",
"deeplink_bank_code": "970436",
"bank_code": "970436",
"account_number": "113366668888",
"account_name": "BAOKIM NGUYEN VAN A",
"amount": 1000000,
"note": "NGUYEN VAN A thanh toan don hang ORD_23456",
"redirect_url": "https://play.google.com/store/apps/details?id=com.tc.baokimplus&hl=vi&pli=1"
}
Response
Bảng tham số chính
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | code | Number(3) | ✅ | Mã lỗi của Baokim |
| 2 | message | String(200) | ✅ | Thông báo mã lỗi của Baokim |
| 3 | data | Object | ✅ | Dữ liệu Baokim trả về |
Thông tin data
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | request_id | String(100) | ✅ | ID duy nhất của Request |
| 2 | deeplink | Object | ✅ | Thông tin Deeplink thanh toán được tạo |
Thông tin deeplink
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | deeplink_url | String(255) | ✅ | Deeplink điều hướng của ứng dụng thanh toán |
| 2 | expired_at | String(20) | ✅ | Thời gian hết hạn của Deeplink. Format: YYYY-MM-DD H:i:s |
Ví dụ Response
{
"code": 0,
"message": "Success",
"data": {
"request_id": "MERCHANT050015588AXE014",
"deeplink": {
"deeplink_url": "https://payment-page.baokim.vn/deeplink?request_id=MERCHANT050015588AXE014&checksum=BC151dsTTmdrSpRapya3rKYJmtu2Ue6e",
"expired_at": "2026-01-11 14:41:00"
}
}
}
Bảng mã lỗi
| Mã lỗi | Mô tả |
|---|---|
| 200 | Thành công |
| 101 | Baokim system error |
| 102 | Thiếu thông tin bắt buộc |
| 104 | Lỗi xác thực OAuth |
| 105 | Lỗi xác thực chữ ký |
| 422 | Lỗi validate tham số |
| 429 | Too many requests |
| 3002 | Payment channel not supported |
| 3010 | Gateway system error |
| 3011 | Gateway system timeout |