Capture
Flow
Description:
- Merchant calls API Capture to capture held funds after successful Authorization.
- Only applies to transactions that have been Authorized.
- If capture amount is less than total authorized amount → Partial Capture (capture portion), remaining amount automatically reverses after 5–7 days.
- After Capture completes, reversal not possible — only Void/Refund can cancel/refund.
API Information
Method: POST
Request
(Parameters sent by merchant)
Main Parameters Table
| No. | Field Name | Data Type | Required | Description |
|---|---|---|---|---|
| 1 | request_id | String(100) | ✅ | Unique ID of request from Merchant to Baokim |
| 2 | request_time | String(20) | ✅ | Request time. Format: YYYY-MM-DD H:i:s |
| 3 | merchant_code | String(50) | ✅ | Unique merchant code |
| 4 | order_code | String(50) | ✅ | Baokim order code from Authentication step |
| 5 | capture_amount | Number | ✅ | Capture amount |
| 6 | extend | Object | ❌ | Extended data (billing) |
| 7 | description | String(255) | ❌ | Capture transaction description |
Example Request
{
"request_id": "MERCHANT050015588AXE012",
"request_time": "2020-08-11 14:41:00",
"merchant_code": "MERCHANT",
"order_code": "VLAD_1753867524",
"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
(Parameters Baokim returns)
Main Parameters Table
| No. | Field Name | Data Type | Required | Description |
|---|---|---|---|---|
| 1 | code | Number(3) | ✅ | Baokim error code |
| 2 | message | String(200) | ✅ | Error message |
| 3 | data | Object | ✅ | Data returned |
Data Information
| No. | Field Name | Data Type | Required | Description |
|---|---|---|---|---|
| 1 | order_code | Number | ✅ | Baokim order code |
| 2 | bank_code | String(50) | ✅ | Bank code |
| 3 | capture_status | Number | ✅ | Status: 0=Pending / 1=Captured / 2=Partial Captured / 3=Fail |
| 4 | status | Number | ✅ | Overall order status |
| 5 | capture_amount | Number | ✅ | Capture amount |
| 6 | total_amount | Number | ✅ | Total order amount |
| 7 | extend | Object | ❌ | Extended data |
Example 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": {}
}
}
Error Code
| Error Code | Description |
|---|---|
| 100 | Success |
| 11 | Failed |
| 101 | Baokim system error |
| 104 | OAuth authentication error |
| 105 | Signature authentication error |
| 301 | Order not found by order_code |
| 302 | Card issue (does not exist, expired) |
| 303 | Card declined |
| 304 | Insufficient card balance |
| 305 | User cancelled transaction |
| 306 | Incorrect OTP |
| 308 | Transaction has not completed Authentication |
| 309 | Transaction has not completed Authorization |
| 310 | Transaction already reversed, cannot capture |
| 311 | Transaction already captured, cannot reverse |
| 313 | Bank-side processing error |
| 422 | Validation error: RequestId invalid |
| 422 | Validation error: RequestTime invalid |
| 422 | Validation error: PartnerCode invalid |
| 422 | Card_data invalid |
| 422 | Amount invalid |