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

Tra cứu giao dịch chia sẻ tiền

Quy trình​

Mô tả:

  • Đối tác gọi API này để tra cứu các lệnh chi đã phát sinh từ giao dịch thu hộ (User, Merchant, CashPlus), phục vụ đối soát.
  • Mỗi lệnh chi là một dòng. Một người nhận có thể có nhiều dòng (lệnh thất bại rồi gọi lại, lệnh AUTO tạo sau cutoff, lệnh chi tay).
  • Chỉ trả dữ liệu thuộc đối tác của partner_code.
  • Kết quả được phân trang.

Thông tin API​

Method: POST

URL: {BASE_URL}/ats/transaction-payment-share

Header: Signature — chữ ký RSA-SHA1 của raw body (xem Bảo mật).

Request​

Bảng tham số chính​

Tên trườngKiểu dữ liệuBắt buộcMô tả
request_idString✅ID request, không trùng request trước. Tối đa 50 ký tự, chỉ gồm chữ, số, _, ., -
request_timeDatetime✅Thời gian request. Format: YYYY-MM-DD HH:mm:ss. Lệch không quá 10 phút so với giờ Baokim
partner_codeString✅Mã đối tác Baokim cung cấp. Dùng để xác thực chữ ký
sub_merchant_codeString❌Lọc theo mã sub merchant
trans_id_bkString❌Lọc theo mã giao dịch thu hộ Baokim (TransactionId)
from_dateDatetime❌Lọc theo thời gian tạo từ. Format: YYYY-MM-DD HH:mm:ss
end_dateDatetime❌Lọc theo thời gian tạo đến. Format: YYYY-MM-DD HH:mm:ss
pageInteger❌Số trang. Mặc định 1
per_pageInteger❌Số bản ghi mỗi trang, từ 1 đến 100. Mặc định 15

Ví dụ Request​

{
"request_id": "REQ20250115103000",
"request_time": "2025-01-15 10:30:00",
"partner_code": "CASHPLUS",
"trans_id_bk": "BK6AB9B10B92C04SZ",
"page": 1,
"per_page": 20
}

Response​

ghi chú

HTTP 200 - Thành công

Bảng tham số chính​

Tên trườngKiểu dữ liệuBắt buộcMô tả
response_codeInteger✅Mã phản hồi. 200 = thành công
response_messageString✅Thông báo
responseObject❌Kết quả phân trang (cấu trúc như Tra cứu Merchant). Không có khi lỗi

Thông tin giao dịch chia sẻ tiền (response.data[])​

Tên trường giữ nguyên như hệ thống trả về (bao gồm chính tả reconciliattion_*).

Tên trườngKiểu dữ liệuMô tả
trans_id_bkStringMã giao dịch thu hộ Baokim (TransactionId)
partner_codeStringMã sub merchant của giao dịch
receiverIntegerNgười nhận: 1 = User, 2 = Merchant, 3 = CashPlus
typeIntegerHình thức chi: 1 = realtime, 2 = T+1
amountIntegerSố tiền chia sẻ (VND)
fee_amountIntegerPhí chi (VND)
spend_amountIntegerSố tiền thực chuyển cho người nhận (VND)
account_noStringSố tài khoản nhận
bank_noStringMã ngân hàng nhận
memoStringNội dung chuyển tiền
trans_id_paymentStringMã lệnh chi phía Baokim (TransIdPayment)
reference_idStringMã lệnh chi phía CashPlus (ReferenceId). null với lệnh AUTO
sourceStringNguồn lệnh: PARTNER = CashPlus gọi, AUTO = Baokim tự tạo sau cutoff (00:05 ngày T+1), MANUAL = chi tay
status_paymentIntegerTrạng thái lệnh: 0 = T+1 chờ quyết toán, 99 = đang xử lý, 200 = thành công, 11 = thất bại
status_payment_endIntegerTrạng thái cuối của lệnh chi
reconciliattion_typeIntegerHình thức quyết toán: 1 = realtime, 2 = T+1
reconciliattion_receiverIntegerNgười nhận khi quyết toán (cùng bảng giá trị với receiver)
reconciliattion_statusIntegerTrạng thái quyết toán
reconciliattion_dateDateNgày quyết toán
reconciliattion_acc_noStringSố tài khoản nhận khi quyết toán
reconciliattion_bank_noStringMã ngân hàng nhận khi quyết toán
updated_end_status_atDatetimeThời gian cập nhật trạng thái cuối
store_codeStringMã cửa hàng
created_atDatetimeThời gian tạo
updated_atDatetimeThời gian cập nhật cuối

Ví dụ Response​

{
"response_code": 200,
"response_message": "Thành công",
"response": {
"current_page": 1,
"data": [
{
"trans_id_bk": "BK6AB9B10B92C04SZ",
"partner_code": "SHOP123",
"trans_id_payment": "TP2501151005010001",
"reference_id": "CPSPEND0001",
"source": "PARTNER",
"amount": 6860,
"type": 1,
"account_no": "0123******89",
"bank_no": "970436",
"receiver": 2,
"status_payment": 200,
"fee_amount": 0,
"spend_amount": 6860,
"memo": "Chi tien don hang",
"reconciliattion_type": 1,
"reconciliattion_status": null,
"reconciliattion_date": null,
"reconciliattion_acc_no": null,
"reconciliattion_bank_no": null,
"updated_end_status_at": null,
"status_payment_end": null,
"store_code": "STORE001",
"reconciliattion_receiver": 2,
"created_at": "2025-01-15 10:00:05",
"updated_at": "2025-01-15 10:00:12"
}
],
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}

Error Codes​

Mã lỗiMô tả
200Thành công
11Lỗi trong quá trình xử lý bên Baokim
104request_id hoặc request_time không hợp lệ (sai định dạng, trùng request_id, hoặc lệch quá 10 phút)
105partner_code không hợp lệ
120Chữ ký không hợp lệ
201Tham số không hợp lệ (response_message nêu trường lỗi)