Capture — Ghi nhận tiền thực tế
Quy trình
- MERCHANT gọi API Capture giao dịch để thực hiện ghi nhận số tiền đã tạm giữ của khách hàng sau khi thực hiện bước Authorize ở trên.
- Chỉ thực hiện capture với giao dịch đã được Authorize trước đó.
- Nếu số tiền yêu cầu capture ít hơn tổng số tiền đã authorize, Baokim sẽ hiểu yêu cầu này là Capture 1 phần (partial capture), phần tiền còn lại sẽ được tự động reversal sau 5-7 ngày.
- Sau khi giao dịch đã hoàn thành Capture sẽ không thể thực hiện reversal mà sẽ dùng Void/Refund để hoàn, huỷ giao dịch
Thông tin API
Method:
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 Baokim từ bước Authentication |
| 6 | capture_amount | Number | ✅ | Số tiền capture |
| 7 | description | String(255) | ❌ | Mô tả giao dịch |
| 8 | extend | Object | ❌ | Dữ liệu mở rộng |
Thông tin extend
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | billing | Object | ❌ | Thông tin người thanh toán |
Thông tin extend.billing
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | firstname | String(255) | ❌ | Tên người thanh toán |
| 2 | lastname | String(255) | ❌ | Họ người thanh toán |
| 3 | address | String(500) | ❌ | Địa chỉ người thanh toán |
| 4 | city | String(50) | ❌ | Thành phố (VD: HANOI) |
| 5 | state | String(255) | ❌ | Bang/Tỉnh |
| 6 | country | String(2) | ❌ | Quốc gia ISO2 (VD: VN) |
| 7 | String(255) | ❌ | Email người thanh toán | |
| 8 | phone | String(10) | ❌ | Số điện thoại |
| 9 | postal_code | String(6) | ❌ | Mã bưu điện |
Ví dụ Request
{
"request_id":"MERCHANT050015588AXE012",
"request_time":" 2020-08-11 14:41:00 ",
"master_merchant_code": "MASTER_MERCHANT",
"sub_merchant_code": "SUB_MERCHANT",
"capture_amount":10100000,
"extend": {
"billing": {
"firstname": "A",
"lastname": "NGUYEN VAN",
"address": "313 Truong Chinh, Dong Da",
"city": "HANOI",
"state": null,
"country": "VN",
"email": "[email protected]",
"phone": "0394899999",
"postal_code": "10000"
}
},
"description": "description GD capture"
}
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 | bank_code | String(50) | ✅ | Mã ngân hàng |
| 3 | capture_status | Number | ✅ | Trạng thái capture: 0 = Pending, 1 = Captured, 2 = Partial Captured, 3 = Fail |
| 4 | status | Number | ✅ | Trạng thái tổng đơn hàng |
| 5 | capture_amount | Number | ✅ | Số tiền capture |
| 6 | total_amount | Number | ✅ | Tổng tiền cuối đơn hàng |
| 7 | extend | Object | ❌ | Dữ liệu mở rộng |
Ví dụ Response
{
"code": 0,
"message": "Success",
"data": {
"order_code": "VLAD_1753867524",
"bank_code": "970415",
"capture_status": 1,
"status": 1,
"capture_amount": 10100000,
"total_amount": 10100000,
"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 |