get https://kong-pp-qa.pc.enstage-sas.com/qa/sm/limitService/limitmanagement/api/v1/customerLimit
The Fetch Customer or Client Payment Limit is used to fetch the customer or client payment limit. For the client payment, you need to pass only the program ID, where as for customer limit, you need to pass program ID, client ID, and bank ID.
Environment
| Sandbox | https://kong-pp-hexappiuat.pc.enstage-sas.com/api/v2/limitService/limitmanagement/ |
| Production | Contact your WIBMO KAM or support. |
Sample request
Client Limit
curl --request GET \
--header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725'
Customer Limit
curl --request GET \
--url 'http://192.168.105.123:2084/api/v2/limitService/limitmanagement/api/v1/customerLimit?programId=1' \
--header 'bankId: 6060' \
--header 'clientId: 1020' \
--header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725'
Response parameters (Decrypted)
This API will provide a token in the response that must be decrypted using the Decrypt API. The decrypted response is similar to the following:
Client Limit
| Attribute | Type | Parameter Requirement | Description |
|---|---|---|---|
| responseCode | String(4) | Mandatory | Contains the status of the transaction. 00 indicates success. |
| responseDateTime | Numeric(14) | Mandatory | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format |
| responseMessage | String(100) | Optional | Response message based on response code will be sent |
| bankId | Numeric(4) | Mandatory | Value copied from request header |
| clientId | String(4) | Mandatory | Unique ID for the client |
| description | String(100) | Optional | Reserved field to send information to client |
| limits.categoryId | Numeric(10) | Optional | Unique ID of the payment category |
| limits.categoryName | String(50) | Optional | Name of the transaction payment category |
| limits.program.perTransactionLimit | Numeric(18) | Optional | Limit allowed for the per transaction |
| limits.program.dailyAmountLimit | Numeric(18) | Optional | Daily amount limit allowed for the customer |
| limits.program.dailyCountLimit | Numeric(10) | Optional | Daily limit count allowed for the customer |
| limits.program.monthlyAmountLimit | Numeric(18) | Optional | Monthly amount limit allowed for the customer |
| limits.program.monthlyCountLimit | Numeric(10) | Optional | Monthly limit count allowed for the customer |
| limits.program.yearlyAmountLimit | Numeric(18) | Optional | Yearly amount limit allowed for the customer |
| limits.program.yearlyCountLimit | Numeric(10) | Optional | Yearly limit count allowed for the customer |
Customer Limit
| Attribute | Type | Parameter Requirement | Description |
|---|---|---|---|
| responseCode | String(4) | Mandatory | Contains the status of the transaction. 00 indicates success. |
| responseDateTime | Numeric(14) | Mandatory | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format |
| responseMessage | String(100) | Optional | Response message based on response code will be sent |
| bankId | Numeric(4) | Mandatory | Value copied from request header |
| clientId | String | Mandatory | Unique ID for the client |
| description | String(100) | Optional | Reserved field to send information to client |
| limits.categoryId | Numeric(10) | Optional | Unique ID of the payment category |
| limits.categoryName | String(50) | Optional | Name of the transaction payment category |
| limits.program.perTransactionLimit | Numeric(18) | Optional | Limit allowed for the per transaction |
| limits.program.dailyAmountLimit | Numeric(18) | Optional | Daily amount limit allowed for the customer |
| limits.program.dailyCountLimit | Numeric(10) | Optional | Daily limit count allowed for the customer |
| limits.program.monthlyAmountLimit | Numeric(18) | Optional | Monthly amount limit allowed for the customer |
| limits.program.monthlyCountLimit | Numeric(10) | Optional | Monthly limit count allowed for the customer |
| limits.program.yearlyAmountLimit | Numeric(18) | Optional | Yearly amount limit allowed for the customer |
| limits.program.yearlyCountLimit | Numeric(10) | Optional | Yearly limit count allowed for the customer |
| limits.customer.perTransactionLimit | Numeric(18) | Optional | Limit allowed for the per transaction |
| limits.customer.dailyAmountLimit | Numeric(18) | Optional | Daily amount limit allowed for the customer |
| limits.customer.dailyCountLimit | Numeric(10) | Optional | Daily limit count allowed for the customer |
| limits.customer.monthlyCountLimit | Numeric(10) | Optional | Monthly limit count allowed for the customer |
| limits.customer.monthlyAmountLimit | Numeric(18) | Optional | Monthly amount limit allowed for the customer |
| limits.customer.yearlyAmountLimit | Numeric(18) | Optional | Yearly amount limit allowed for the customer |
| limits.customer.yearlyCountLimit | Numeric(10) | Optional | Yearly limit count allowed for the customer |
Sample response (Decrypted)
Client Limit
{
"description": "Customer Limit Success",
"responseCode": "00",
"clientId": "1040",
"bankId": "2040",
"programId": 1,
"responseDateTime": "20230203114910",
"responseMessage": "SUCCESS",
"limits": [
{
"categoryId": "1234",
"categoryName": "Merchant Payments",
"program": {
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
}
},
{
"categoryId": "1235",
"categoryName": "Fund Transfer",
"program": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
}
},
{
"categoryId": "5678",
"categoryName": "Bill Pay and Recharge",
"program": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000
}
}
]
}
Customer Limit
{
"description": "Customer Limit Success",
"responseCode": "00",
"clientId": "1040",
"bankId": "2040",
"programId": 1,
"customerId": "000023",
"responseDateTime": "20230203114910",
"responseMessage": "SUCCESS",
"limits": [
{
"categoryId": "1234",
"categoryName": "Merchant Payments",
"program": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
},
"customer": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
}
},
{
"categoryId": "1235",
"categoryName": "Fund Transfer",
"program": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
},
"customer": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
}
},
{
"categoryId": "5678",
"categoryName": "Bill Pay and Recharge",
"program": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
},
"customer": {
"perTransactionLimit": 1000,
"dailyCountLimit": 50,
"dailyAmountLimit": 10000,
"monthlyCountLimit": 1000,
"monthlyAmountLimit": 200000,
"yearlyCountLimit": 10000,
"yearlyAmountLimit": 2400000
}
}
]
}