Hoàn tiền giao dịch

Quy trình

Dùng khi khách hàng yêu cầu trả hàng / huỷ dịch vụ (sau khi đã Capture).

Thông tin API

Method: POST

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 merchan
4	sub_merchant_code	String(50)	✅	Mã định danh duy nhất cho sub merchant
5	order_code	String(50)	✅	Mã đơn Baokim từ bước Authentication
6	refund_amount	Number	❌	Số tiền hoàn (để trống = hoàn toàn bộ)
7	reason	Text	❌	Lý do hoàn
8	extend	Object	❌	Dữ liệu mở rộng

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",
  "reason": "yêu cầu hủy đơn",
  "extend": {}
}

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	order_code	String	✅	Mã đơn hàng Baokim
2	refund_status	Number	✅	0 = Pending, 1 = Refunded, 2 = Fail
3	refund_type	Number	✅	1 = Void, 2 = Refund
4	status	Number	✅	Trạng thái tổng đơn hàng
5	extend	Object	❌	Dữ liệu mở rộng

Ví dụ Response

{
  "code": 0,
  "message": "Success",
  "data": { 
    "order_code": "VLAD_1753867524", 
    "refund_status": 1, 
    "refund_type": 1, 
    "status": 9,
    "extend": {}}
}

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