Hoàn / Huỷ

Quy trình

Thông tin API

Method: POST

URL: /api/merchant-hosted/bank-transfer/refund

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(50)	✅	ID duy nhất của request. Đề xuất format: MerchantCode+YYYYMMDDHHIISS+UniqueId
2	request_time	String(19)	✅	Thời gian gửi request. Format: YYYY-MM-DD HH:II:SS
3	order_id	Integer	✅	Mã giao dịch tại Baokim
4	refund_reason	String(255)	✅	Lý do huỷ đơn hàng
5	refund_amount	Integer	✅	Số tiền hoàn (có thể hoàn một phần)
6	merchant_code	String(30)	✅	Mã merchant
7	bank_code	String(30)	❌	Mã bank nhận tiền — dùng khi chuyển tiền bằng ví hoặc không tìm thấy thông tin người thụ hưởng (mã lỗi 5)
8	acc_no	String(22)	❌	Số tài khoản nhận tiền — dùng khi chuyển tiền bằng ví hoặc không tìm thấy thông tin người thụ hưởng (mã lỗi 5)

Ví dụ Request

{
  "request_id": "BK20250717140001",
  "request_time": "2025-07-17 14:00:00",
  "order_id": 1141313,
  "refund_amount": 500000,
  "merchant_code": "PARTNER001",
  "refund_reason": "Yêu cầu hủy"
}

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	Integer(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	String(25)	✅	Mã đơn hàng bên Baokim
2	mrc_order_id	String(25)	✅	Mã đơn hàng bên Merchant
3	refund_amount	Integer	✅	Số tiền hoàn
4	refund_fee	Integer	✅	Phí hoàn
5	refund_time	Datetime	✅	Thời gian hoàn
6	refund_charge_by	Integer	❌	Ai chịu phí: 1 = Merchant, 2 = User
7	status	Integer	✅	Trạng thái hoàn: 1 = Thành công, 2 = Thất bại, 3 = Pending

Ví dụ Response

{
  "code": 0,
  "message": "Thành công",
  "data": {
    "order_id": "BK20250717140001",
    "mrc_order_id": "ORD123456789",
    "refund_amount": 148000,
    "refund_fee": 2000,
    "refund_charge_by": 2,
    "status": 1,
    "refund_time": "2025-07-17 14:01:10"
  }
}

Error Codes

code	message
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