Chuyển tới nội dung chính

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

URL: /api/merchant-hosted/bnpl/detail

Request​

(Tham số đối tác gửi lên)

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1request_idString(100)✅ID duy nhất của request từ Merchant sang Baokim
2request_timeString(20)✅Thời gian gửi request. Format: YYYY-MM-DD H:i:s
3merchant_codeString(50)✅Mã định danh duy nhất của Merchant
4mrc_order_idString(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​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1codeNumber(3)✅Mã lỗi của Baokim
2messageString(200)✅Thông báo mã lỗi
3dataObject✅Dữ liệu trả về

Thông tin data​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1order_idNumber✅Mã đơn hàng Baokim
2mrc_order_idString(50)✅Mã đơn hàng Merchant
3merchant_codeString(50)✅Mã định danh duy nhất cho đối tác: MERCHANT
4customer_nameString(200)✅Tên đầy đủ khách hàng, không dấu, có khoảng trắng
5customer_phoneString(10)✅Số điện thoại khách hàng
6customer_emailString(255)✅Email khách hàng
7customer_addressString(500)✅Địa chỉ khách hàng
8package_codeString(255)✅Mã gói vay
9nameString(20)✅Tên gói vay
10periodNumber✅Kỳ hạn (1, 3, 6, 9, 12 tháng)
11min_amountNumber✅Số tiền tối thiểu để áp dụng gói vay
12max_amountNumber✅Số tiền tối đa để áp dụng gói vay
13down_payment_percentNumber✅% số tiền trả trước
14down_payment_amountNumber✅Số tiền trả trước
15original_amountNumber✅Số tiền đơn hàng
16user_feeNumber✅Phí user chịu
17merchant_feeNumber✅Phí người bán chịu
18total_paylater_amountNumber✅Tổng số tiền trả sau (đã tính phí)
19payment_per_periodNumber✅Số tiền trả mỗi kỳ
20total_amountNumber✅Tổng số tiền user cần thanh toán (trả trước + trả sau)
21difference_amountNumber✅Số tiền chênh lệch so với trả thẳng
22document_requiredString❌Loại giấy tờ yêu cầu xác minh (VD: CCCD)
23provider_codeString(20)✅Tên tổ chức tài chính
24descriptionString(255)✅Mô tả đơn hàng
25url_successString(255)✅URL redirect khi duyệt vay thành công
26url_failString(255)✅URL redirect khi duyệt vay thất bại
27statusNumber✅Trạng thái đơn hàng
28extensionObject✅Thông tin mở rộng (danh sách sản phẩm)
29created_atDatetime✅Thời gian tạo đơn hàng
30updated_atDatetime✅Thời gian cập nhật đơn hàng

Thông tin extension​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1itemsArray✅Danh sách object sản phẩm

Thông tin items​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1item_idNumber❌Mã định danh sản phẩm phía merchant
2item_codeString(50)✅Mã sản phẩm
3item_nameString(255)✅Tên sản phẩm
4item_amountNumber✅Giá tiền sản phẩm
5quantityNumber✅Số lượng sản phẩm
6urlString(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ỗiMô tả
100Thành công
101Lỗi hệ thống
102Lỗi nhà cung cấp
104Lỗi xác thực JWT
105Chữ ký số không hợp lệ
106Số 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
110Mã đơn hàng merchant đã tồn tại
422Lỗi validate