The Device Usage Control API enables the cardholder to toggle between the card control usages, wherein the cardholder can allow or restrict the card usage for international and domestic ATM, POS, e-commerce, contactless, MDES in-app or VTS in-app, MDES contactless or VTS contactless, and MDES token QR transactions based on the activation type provided in the input. The Credit+ Issuing system receives, validates, and processes the request. If the request is successful, the device usage is allowed or restricted on the card. The system then logs the Device Usage Control (service code: 454) service request (SR) and sends the service request details in the response message. In case of API channel, the SR is processed immediately irrespective of whether the checker/maker configuration is enabled for this SR or not. If the request fails, the system returns the corresponding error code in the response and the SR is not logged.
The following validations are performed during activation and deactivation:
• The highest priority is given to lifelong activation, followed by periodic activation, and lastly the immediate activation in hours.
• If any combination of channel activation type and origin exist, and the lifelong activation request for all channels is received, then the request is accepted. However, if all these combinations are received again in a request, then the request is declined.
• If the periodic or hourly activation for all channels is existing and the lifelong activation request is received, then the request is accepted
• Ifthe periodic activation or deactivation for all or any ofthe channelsis existing, then the activation for same or overlapping period is not allowed.
• If lifelong activation or deactivation is existing and a periodic or hourly request is initiated with the same combination of lifelong, then the new periodic and hourly request does not get processed.
• If one or more channels (not all) is configured for lifelong activation or deactivation, and the request is initiated for all channels, then the remaining channels are also activated or deactivated for lifelong. The existing channel entry in the channel transaction setting does not change.
HTTP Status and Response Status Matrix
- HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
- Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
- Reason: This is the description of the error code returned by Credit+ Issuing application.
| HTTP Code | Error Code | Reason |
|---|---|---|
| 201 | HDS000 | Request processed successfully |
| 403 | 900 | Invalid User |
| 404 | 998 | Device(s) does not exist |
| 500 | 999 | Invalid Request Type |
| 400 | 997 | Device Number field is mandatory. |
| 400 | 997 | Device Number field should be numeric. |
| 400 | 997 | Priority Request field is invalid. |
| 400 | 997 | Request Date field is mandatory. |
| 400 | 997 | Request Date field must be in MM/dd/yyyy HH:mm:ss format. |
| 400 | 997 | Form Factor Type field is mandatory. |
| 400 | 997 | Form Factor Type field is invalid. |
| 400 | 997 | Form Factor field is mandatory. |
| 400 | 997 | Form Factor field value must have max length 24. |
| 400 | 997 | Activation Flag field is mandatory. |
| 400 | 997 | Activation Flag field is invalid. |
| 400 | 997 | Transaction Origin field is mandatory. |
| 400 | 997 | Transaction Origin field is invalid. |
| 400 | 997 | Transaction Channel field is mandatory. |
| 400 | 997 | Transaction channel field value must have length 4. |
| 400 | 997 | Atleast one transaction channel required as '1' |
| 400 | 997 | Only numeric characters 0 and 1 are allowed. |
| 400 | 997 | Activation Type field is mandatory. |
| 400 | 997 | Activation Type field is invalid. |
| 400 | 997 | Channel field is invalid. |
| 400 | 997 | Transaction country is not allowed for activation Type {}. |
| 400 | 997 | Transaction country is not allowed for non international transactions |
| 400 | 997 | Transaction country is mandatory. |
| 400 | 997 | Transaction country is invalid. |
| 400 | 997 | Country code {} is invalid. |
| 400 | 997 | Start Date is not allowed for Activation Type - 'Time in Hrs'. |
| 400 | 997 | End Date is not allowed for Activation Type - 'Time in Hrs'. |
| 400 | 997 | Time in Hrs field is mandatory. |
| 400 | 997 | Time in Hrs field should be numeric. |
| 400 | 997 | Time in Hrs field should be between 1 to 24. |
| 400 | 997 | Time in Hrs field should be between 1 to 24. |
| 400 | 997 | Start Date field is mandatory. |
| 400 | 997 | End Date field is mandatory. |
| 400 | 997 | Start Date field must be in dd/MM/yyyy format. |
| 400 | 997 | End Date field must be in dd/MM/yyyy format. |
| 400 | 997 | Time in Hrs is not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | End Date is not allowed for Activation Type - 'Life Long Activation'.Start Date is not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | Product Type field is invalid. |
| 400 | 997 | Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character. |
| 400 | 997 | Program Code field value must have max length 10. |
| 400 | 997 | Device Plan Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character. |
| 400 | 997 | Device Plan Code field value must have max length 10. |
| 400 | 997 | Request Date should be less than or equal to institution date. |
| 400 | 997 | Start Date should be equal to or greater than institution date. |
| 400 | 997 | End Date should be greater than institution date. |
| 400 | 997 | End Date should be greater than start date. |
| 400 | CNA003 | Record does not exists for the given details |
| 400 | CNA005 | Multiple device numbers are active for given details |
| 400 | CNA006 | Error while fetching device details |
| 400 | 927 | Invalid Country |
| 400 | 998 | DEVICE_ERROR |
| 500 | INT101 | Error while retriving data from device |
| 500 | INT102 | Error while executing International allow/disallow API |
| 500 | HDEERR004 | Internal error occurred |
| 400 | HDE100 | Device is not normal |
| 400 | INT201 | country white list plan not available |
| 400 | INT201 | Selected country is blacklisted |
| 400 | HDE259 | Device is already deactivated for life long. |
| 400 | HDE260 | Device is already activated for life long. |
| 400 | HDE261 | DEVICE is already activated. |
| 400 | HDE262 | Start Date is not allowed for Activation Type - 'Life LongDevice is already deactivated for a specific period for same transaction mode. |
| 400 | HDE263 | Device is already activated for given date range. |
| 400 | HDE264 | Only activated device will be deactivate. |
| 400 | HDE270 | Device is already activated for a specific period for same transaction mode. |
| 400 | HDE417 | Error while processing request |
| 400 | BTHCM00018 | Error while processing request |
| 400 | 913 | Backward offset time limit violated. |
| 400 | 944 | Invalid Request - Unrecognized field. |
| 400 | 988 | Encryption type Not Supported |
| 400 | 913 | Forward offset time limit violated. |
| 400 | DUCE001 | Exception occurred while fetching the existing details. |
| 400 | DUC0003 | Device is already activated for lifelong |
| 400 | DUC0004 | Device is already deactivated for lifelong |
| 400 | HDE274 | Device is already activated for a specific period for same transaction mode and country |
| 400 | HDE276 | Device is already deactivated for a specific period for same transaction mode and country |
| 400 | DUC0007 | Device is already activated for lifelong |
| 400 | DUC0008 | Device is already deactivated for lifelong |
| 400 | DUC0010 | Device is already activated for a specific period for same transaction mode and country |
| 400 | DUC0011 | Device is already activated for a specific period for same transaction mode |
| 400 | DUC0012 | Device is already deactivated for a specific period for same transaction mode and country |
| 400 | DUC0013 | Device is already deactivated for a specific period for same transaction mode |
| 400 | DUC0015 | Device is already activated for specific hours |
| 400 | DUC0016 | Device is already deactivated for specific hours |
| 400 | DUCE111 | Internal error while processing the request |
| 400 | DUC0017 | Request has been rejected, as the Device Usage Control settings are already present in the system for selected channels or Pre-digitization is not done on device for MDES/VTS channels. |
| 400 | INT200 | Error while fetching the white and black list country code plan |
| 400 | HDE232 | Start date should be greater than or equal to Institution Current Local Date. |
| 400 | HDE1030 | Request has been rejected as pre-digitization is not done for the device. Please try again after pre-digitization of the device. |
| 400 | HDE279 | Requested Details of one of the channels and origin is overlapping with existing device usage, hence rejecting the multi-channel request. |
| 400 | 994 | Invalid Encryption-Algorithm header value |
| 400 | 994 | Invalid Encryption Request Parameters |
| 400 | 994 | Cryptography error |