Check Card Installment Support
Flow
Description:
- Merchant sends bank code and card BIN prefix to Baokim to check.
- Merchant needs to check the list of supported BINs from the "Retrieve banks and installment loan packages" API response, get the longest BIN prefix length, and send the customer's BIN prefix according to that length.
- Baokim returns whether the card supports installment.
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 the request from Merchant to Baokim |
| 2 | request_time | String(20) | ✅ | Request sent time. Format: YYYY-MM-DD H:i:s |
| 3 | merchant_code | String(50) | ✅ | Unique merchant identifier |
| 4 | bank_no | String(6) | ✅ | Unique bank code on Baokim |
| 5 | bin | String(12) | ✅ | Card BIN prefix |
Request Example
{
"request_id": "MERCHANT050015588AXE00",
"request_time": "2020-08-05 09:00:00",
"merchant_code": "MERCHANT",
"bank_no": "970436",
"bin": "5339682111"
}
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 | bank_name | String(255) | ✅ | Full bank name |
| 2 | bank_short_name | String(20) | ✅ | Bank short name |
| 3 | bank_no | String(6) | ✅ | Bank code on Baokim |
| 4 | bank_logo | String(255) | ✅ | Bank logo |
| 5 | bin | String(50) | ✅ | Card BIN prefix |
Response Example
{
"code": 0,
"message": "Issuer identification number is supported",
"data": {
"bank_name": "Ngân hàng TMCP Ngoại thương Việt Nam",
"bank_short_name": "VIETCOMBANK",
"bank_no": "970436",
"bank_logo": "https://public-cdn.baokim.vn/statics/img/banks/VIETCOMBANK.png",
"bin": "5339682111"
}
}
Error Codes
| Error Code | Description |
|---|---|
| 200 | Success |
| 11 | Failure |
| 101 | Baokim system error |
| 102 | Basic auth authentication error |
| 103 | Signature authentication error |
| 104 | Validation error: Invalid RequestId |
| 105 | Validation error: Invalid RequestTime |
| 106 | Validation error: Invalid PartnerCode |
| 107 | Validation error: Invalid CustomerName |
| 108 | Validation error: Invalid CustomerPhone |
| 109 | Validation error: Invalid CustomerEmail |
| 110 | Validation error: Invalid BankCode |
| 112 | Validation error: Invalid ClientIdNo |
| 113 | Validation error: Invalid AuthCode |
| 114 | Validation error: Invalid CardNo |
| 118 | Validation error: Invalid ReferenceId |
| 122 | Validation error: Invalid ConversionMoney |
| 123 | Validation error: Invalid PayPerMonth |
| 124 | Validation error: Invalid InstallmentAmount |
| 125 | Validation error: Invalid TotalPaymentAmount |
| 126 | Installment bank and card issuer bank do not match |
| 127 | Validation error: Invalid Operation |
| 142 | Invalid status |
| 157 | Card BIN does not support installment |
| 159 | Invalid start time (fromTime) |
| 160 | Invalid end time (toTime) |
| 168 | Invalid installment term |
| 170 | Loan package not configured on Baokim |
| 171 | Transaction cancellation not supported |
| 174 | Invalid cancellation time |
| 176 | Invalid payment time |
| 177 | Invalid cancellation reason |