Tra cứu giao dịch

Quy trình

MERCHANT gọi api này để lấy ra các thông tin của đơn hàng, trạng thái tại thời điểm request của đơn hàng.

Thông tin API

Method: GET

URL:

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 của request
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	order_code	String(50)	✅	Mã đơn của Baokim trả về tại bước Authentication

Ví dụ Request

{
  "request_id": "MERCHANT050015588AXE014",
  "request_time": "2020-08-11 14:41:00",
  "master_merchant_code": "MASTER_MERCHANT",
  "sub_merchant_code": "SUB_MERCHANT",
  "order_code": "VLAD_1753867524"
}

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(3)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	order_code	String	✅	Mã đơn hàng Baokim
2	amount	Number	✅	Số tiền đơn hàng
3	status	Number	✅	Trạng thái đơn hàng
4	created_at	Datetime	✅	Thời gian tạo
5	updated_at	Datetime	✅	Thời gian cập nhật
6	steps	Object	✅	Lịch sử từng bước

Thông tin steps(6)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	authentication	Object	✅	Thông tin bước Authentication
2	authorize	Array	✅	Danh sách giao dịch Authorize
3	capture	Array	✅	Danh sách giao dịch Capture
4	refund	Array	❌	Danh sách giao dịch Refund
5	reversal	Array	❌	Danh sách giao dịch Reversal
6	void	Array	❌	Danh sách giao dịch Void

Thông tin authentication(1)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	authen_status	Number	✅	Trạng thái xác thực thẻ: 0 = Chờ, 1 = Đã xác thực, 2 = Thất bại, 3 = Bypass
2	authen_amount	Number	✅	Số tiền authentication
3	request_time	String(20)	✅	Thời gian request. Format: YYYY-MM-DD H:i:s
4	card	Object	✅	Token thẻ cần thanh toán UCOF
5	url_success	String(255)	✅	URL Baokim redirect về khi xác thực thành công
6	url_fail	String(255)	✅	URL Baokim redirect về khi xác thực thất bại
7	off_3ds	Number	❌	Có yêu cầu tắt xác thực 3DS không ?: 0 = Không, 1 = Có
8	3ds_url	String(255)	✅	Link 3DS
9	extend	Object	❌	Dữ liệu mở rộng

Thông tin authorize(2)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	authorize_status	Number	✅	Trạng thái authorization: 0 = Pending, 1 = Authorized, 2 = Fail
2	authorize_amount	Number	✅	Số tiền
3	request_time	String(20)	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
4	authorize_type	Number	✅	Loại authorize: 1 = Authorize, 2 = Incremental
5	auth_code	String(50)	✅	Mã từ ngân hàng
6	description	String(255)	❌	Mô tả
7	extend	Object	❌	Dữ liệu mở rộng

Thông tin capture(3)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	capture_status	Number	✅	Trạng thái capture: 0 = Pending, 1 = Captured, 2 = Partial, 3 = Fail
2	bank_code	String(50)	✅	Mã ngân hàng
3	capture_type	Number	✅	Loại capture: 1 = Capture, 2 = Partial Capture
4	capture_amount	Number	✅	Số tiền
5	request_time	String(20)	✅	Thời gian
6	extend	Object	❌	Dữ liệu mở rộng
7	description	String(255)	❌	Mô tả giao dịch

Thông tin refund(4)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	refund_status	Number	✅	Trạng thái refund: 0 = Pending, 1 = Refunded, 2 = Fail
2	refund_amount	Number	✅	Số tiền hoàn
3	request_time	String(20)	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
4	description	String(255)	✅	Mô tả
6	extend	Object	❌	Dữ liệu mở rộng

Thông tin reversal(5)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	refund_status	Number	✅	Trạng thái refund: 0 = Pending, 1 = Refunded, 2 = Fail
2	description	String(255)	✅	Mô tả
3	request_time	String(20)	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
4	extend	Object	❌	Dữ liệu mở rộng

Thông tin void(6)

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	void_status	Number	✅	Trạng thái void: 0 = Pending, 1 = Reversed/Voided, 2 = Fail
2	description	String(255)	✅	Mô tả
3	request_time	String(20)	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
4	extend	Object	❌	Dữ liệu mở rộng

Ví dụ Response

{
  "code": 0,
  "message": "Success",
  "data": {
    "order_code": "VLAD_1753867524",
    "amount": 1000000,
    "status": 1,
    "created_at": "2020-08-11 14:41:00",
    "updated_at": "2020-08-11 15:41:00",
    "steps": {
      "authentication": {
        "authen_status": 1,
        "authen_amount": 1000000,
        "request_time": "2020-08-11 14:41:00",
        "url_success": "https://example.com/success",
        "url_fail": "https://example.com/fail",
        "off_3ds": 1,
        "3ds_url": "https://payment-page.baokim.vn/payment/?oid=38260&checksum=d863a2d66f76e3fc7bcfe302bfc19ff3e5253f5c",
        "extend": {}
      },
      "authorize": [
        {
          "authorize_status": 1,
          "authorize_amount": 1000000,
          "request_time": "2020-08-11 14:41:00",
          "authorize_type": 1,
          "auth_code": "AUTH456789",
          "description": "",
          "extend": {}
        }
      ],
      "capture": [
        {
          "capture_status": 1,
          "capture_amount": 1000000,
          "request_time": "2020-08-11 14:41:00",
          "bank_code": "970436",
          "capture_type": 1,
          "description": "",
          "extend": {}
        }
      ],
      "refund": [],
      "reversal": [],
      "void": []
    }
  }
}

Bảng mã lỗi Response Code

Mã lỗi	Mô tả
100	Thành công
11	Thất bại
101	Lỗi hệ thống Baokim
104	Lỗi xác thực Oauth
105	Lỗi xác thực chữ ký
422	Lỗi validate: RequestId không hợp lệ
422	Lỗi validate: RequestTime không hợp lệ
422	Lỗi validate: PartnerCode không hợp lệ
422	Card_data không hợp lệ
422	Amount không hợp lệ
301	Không tìm thấy đơn hàng theo order_code
302	Thẻ có vấn đề (không tồn tại, hết hạn)
303	Thẻ bị từ chối
304	Thẻ không đủ số dư
305	User huỷ giao dịch
306	Sai mã OTP
308	Giao dịch chưa thực hiện Authentication
309	Giao dịch chưa thực hiện Authorize
310	Giao dịch đã reversal — không thể capture
311	Giao dịch đã capture — không thể reversal
313	Lỗi xử lý phía ngân hàng