Tra cứu giao dịch
Quy trình
Mô tả:
- Merchant gọi API để tra cứu thông tin chi tiết giao dịch BNPL theo mã đơn hàng.
- Baokim tìm kiếm giao dịch theo những tham số mà MERCHANT gửi lên sau đó trả về danh sách giao dịch thoả mãn yêu cầu.
Thông tin API
Method: GET
Request
(Tham số đối tác gửi lên)
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 của request từ Merchant sang Baokim |
| 2 | request_time | String(20) | ✅ | Thời gian gửi request. Format: YYYY-MM-DD H:i:s |
| 3 | merchant_code | String(50) | ✅ | Mã định danh duy nhất của Merchant |
| 4 | mrc_order_id | String(50) | ✅ | Mã giao dịch duy nhất bên đối tác gửi lên (do phía đối tác tự sinh, có thể coi là mã đơn hàng) |
Ví dụ Request
{
"request_id": "MERCHANT050015588AXE014",
"request_time": "2020-08-11 14:41:00",
"merchant_code": "MERCHANT",
"mrc_order_id": "VLAD_1753867524"
}
Response
(Tham số Baokim trả về)
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 |
| 3 | data | Object | ✅ | Dữ liệu trả về |
Thông tin data
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | order_id | Number | ✅ | Mã đơn hàng Baokim |
| 2 | mrc_order_id | String(50) | ✅ | Mã đơn hàng Merchant |
| 3 | merchant_code | String(50) | ✅ | Mã định danh duy nhất cho đối tác: MERCHANT |
| 4 | customer_name | String(200) | ✅ | Tên đầy đủ khách hàng, không dấu, có khoảng trắng |
| 5 | customer_phone | String(10) | ✅ | Số điện thoại khách hàng |
| 6 | customer_email | String(255) | ✅ | Email khách hàng |
| 7 | customer_address | String(500) | ✅ | Địa chỉ khách hàng |
| 8 | package_code | String(255) | ✅ | Mã gói vay |
| 9 | name | String(20) | ✅ | Tên gói vay |
| 10 | period | Number | ✅ | Kỳ hạn (1, 3, 6, 9, 12 tháng) |
| 11 | min_amount | Number | ✅ | Số tiền tối thiểu để áp dụng gói vay |
| 12 | max_amount | Number | ✅ | Số tiền tối đa để áp dụng gói vay |
| 13 | down_payment_percent | Number | ✅ | % số tiền trả trước |
| 14 | down_payment_amount | Number | ✅ | Số tiền trả trước |
| 15 | original_amount | Number | ✅ | Số tiền đơn hàng |
| 16 | merchant_fee | Number | ✅ | Phí người bán chịu |
| 17 | total_paylater_amount | Number | ✅ | Tổng số tiền trả sau (đã tính phí) |
| 18 | payment_per_period | Number | ✅ | Số tiền trả mỗi kỳ |
| 19 | total_amount | Number | ✅ | Tổng số tiền user cần thanh toán (trả trước + trả sau) |
| 20 | difference_amount | Number | ✅ | Số tiền chênh lệch so với trả thẳng |
| 21 | provider_code | String(20) | ✅ | Tên tổ chức tài chính |
| 22 | description | String(255) | ✅ | Mô tả đơn hàng |
| 23 | url_success | String(255) | ✅ | URL redirect khi duyệt vay thành công |
| 24 | url_fail | String(255) | ✅ | URL redirect khi duyệt vay thất bại |
| 25 | status | Number | ✅ | Trạng thái đơn hàng |
| 26 | extension | Object | ✅ | Thông tin mở rộng (danh sách sản phẩm) |
| 27 | created_at | Datetime | ✅ | Thời gian tạo đơn hàng |
| 28 | updated_at | Datetime | ✅ | Thời gian cập nhật đơn hàng |
Thông tin extension
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | items | Array | ✅ | Danh sách object sản phẩm |
Thông tin items
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | item_code | String(50) | ✅ | Mã sản phẩm |
| 2 | item_name | String(255) | ✅ | Tên sản phẩm |
| 3 | item_amount | Number | ✅ | Giá tiền sản phẩm |
| 4 | quantity | Number | ✅ | Số lượng sản phẩm |
| 5 | url | String(500) | ✅ | Link sản phẩm |
Ví dụ Response
{
"code": 0,
"message": "Success",
"data": {
"order_id": 1870436,
"mrc_order_id": "VLAD_1753867524",
"merchant_code": "MERCHANT",
"customer_name": "Nguyễn Trung Quân",
"customer_phone": "0394827170",
"customer_email": "[email protected]",
"customer_address": "40, ngách 16/255 đường Láng, Đống Đa, Hà Nội",
"package_code": "homecredit_1month",
"name": "Home Credit 1 tháng",
"period": 1,
"min_amount": 1000000,
"max_amount": 500000,
"down_payment_percent": 20,
"down_payment_amount": 2000000,
"original_amount": 10000000,
"user_fee": 0,
"merchant_fee": 100000,
"total_paylater_amount": 8000000,
"payment_per_period": 8000000,
"total_amount": 10100000,
"difference_amount": 100000,
"document_required": "CCCD",
"provider_code": "HOMECREDIT",
"description": "Đơn hàng trả chậm",
"url_success": "https://example.com/success",
"url_fail": "https://example.com/fail",
"status": 1,
"extension": {
"items": [
{
"item_id": 123456,
"item_code": "AEIQ_4562",
"item_name": "Máy tính xách tay ABC",
"item_amount": 10000000,
"quantity": 1,
"url": "https://example.com/product-detail"
}
]
},
"created_at": "2020-08-11 14:41:00",
"updated_at": "2020-08-11 15:41:00"
}
}
Bảng mã lỗi
| Mã lỗi | Mô tả |
|---|---|
| 100 | Thành công |
| 101 | Lỗi hệ thống |
| 102 | Lỗi nhà cung cấp |
| 104 | Lỗi xác thực JWT |
| 105 | Chữ ký số không hợp lệ |
| 106 | Số tiền đơn hàng không đủ để hoàn tiền |
| 107 | Đơn hàng không thể hoàn |
| 108 | Đơn hàng không thể hủy |
| 109 | Đơn hàng không tồn tại |
| 110 | Mã đơn hàng merchant đã tồn tại |
| 422 | Lỗi validate |