Cancel Payment
Path
- URL:
/cb-core/api/v1/payment/cancel - Method:
POST - Description: This API is used to cancel an payment.
Request
Request Table
| Params | Data Type + Length | Required | Description |
|---|---|---|---|
| request_id | string(50) | Yes | Unique request ID, suggested format: MerchantCode+YYYYMMDDHHMMSS+UniqueId |
| request_time | string(19) | Yes | Request time in format: YYYY-MM-DD HH:MM:SS |
| merchant_code | string(20) | Yes | Merchant code provided by Baokim before integration |
| sub_merchant_code | string(20) | Yes | If the Seller is under your sub-merchant, fill your sub merchant code provided by Baokim. If Seller is under you, fill your Merchant_code provided by Baokim as above |
| seller_id | string(50) | Yes | Seller ID on merchant's system |
| merchant_payment_id | string(50) | Yes | Merchant payment's ID |
Request Example
Request example for payment method is QRCODE/VA
{
"request_id": "MERCHANT12345678901234510281",
"request_time": "2024-11-15 14:36:00",
"merchant_code": "PHUONGTT",
"sub_merchant_code": "SUBPHUONGTT",
"seller_id": "SELLER12345678901234510281",
"merchant_payment_id": "1234567890"
}
Response
Response Table
| Params | Data Type + Length | Required | Description |
|---|---|---|---|
| response_code | int(4) | Yes | Error code from Baokim as per Error Codes Table |
| response_message | string(100) | Yes | Description of the error code from Baokim as per Error Codes Table |
Response Example
{
"response_code": 200,
"response_message": "Success"
}
Error Code
| Response Code | Response Message |
|---|---|
| 200 | Success |
| 11 | Failed |
| 101 | System Error |
| 110 | Merchant Code Invalid |
| 120 | Invalid Signature |
| 422 | Validation Error |