post https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/helpdesk/domesticusageenable
This API is used to enable the usage of card for ATM, POS and/or e-commerce transactions done in the home country of the cardholder through various channels such as online banking or mobile banking for the specified duration. The Credit+ Issuing system receives, validates and processes the request. If the request is successful, domestic usage is enabled on the card, system logs the Device Usage Control (service code: 454)service request (SR) and sendsthe service request detailsin 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. **NOTE:
- The API, if sent with cardNumberAlias (CNA), will internally fetch the corresponding associated device for further processing only if DEVICE _STATUS_CODE = NORMAL (0) OR (DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1).
- Either deviceNumber or cardNumberAlias parameter’s value must be provided to process the request. However, if both are received in request then the system will not validate if the cardNumberAliasislinked to that particular device. System processesthe request based on the device number itself.**
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 | CDUSG000 | Request processed successfully |
| 201 | CCRBO0004 | Request processed successfully |
| 403 | 900 | Invalid User |
| 404 | 998 | Device(s) does not exist |
| 500 | 999 | Invalid Request Type |
| 400 | 997 | Start Date field is mandatory |
| 400 | 997 | Start Date must be in dd/MM/yyyy format. |
| 400 | 997 | End Date field is mandatory |
| 400 | 997 | End Date must be in dd/MM/yyyy format. |
| 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 6. |
| 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 greater than or equal to institution date. |
| 400 | 997 | End Date should be greaterthan or equal to institution date |
| 400 | 997 | End Date should be greater than or equal to start date. |
| 400 | CNA001 | Bank Does Not Exists. |
| 400 | CNA002 | Card Number Alias Functionality is not applicable forthisInstitution. |
| 400 | CNA003 | Record does not exists for the given details |
| 400 | CNA005 | Multiple device numbers are active for given details |
| 500 | CNA006 | Error while fetching device details |
| 400 | 998 | Invalid device number. |
| 400 | DOM001 | Invalid device number. |
| 500 | DOM002 | Error while fetching details from device. |
| 500 | DOM105 | Error while executing Domestic Usage Enable API |
| 400 | HDE050 | Institution code is mandatory |
| 400 | HDE051 | Device number is mandatory |
| 400 | HDE052 | Service code is mandatory. |
| 500 | HDE053 | Error in fetching data from service_code_mst. |
| 400 | HDE054 | Active request Already exist |
| 400 | HDE523 | This Service Request is not allowed for Addon device |
| 400 | HDE524 | This Service Request is not allowed for closed device |
| 500 | HDE053 | Error in fetching data from service_code_mst |
| 400 | SERVIC001 | Service request is not applicable to product type. |
| 400 | HDE100 | Service not allowed, DEVICE status is <STATUS_CODE>. NOTE: This error code will return for the following STATUS_CODEs: 1: Supervision, 3: Cancelled, 4: Replaced, 5: Lost, 6: Stolen, 7: Counterfeit, 8: Returned, 9: Upgrade (future use), 10: Returned Card Renewal (future use), 11: Not activated Card, 12: Expired, 13: Inactive |
| 400 | HDE012 | DEVICE is in production |
| 500 | 913 | Backward offset time limit violated. |
| 400 | 994 | Invalid Request - Unrecognized field. |
| 400 | 988 | Encryption type Not Supported. |
| 400 | 913 | Forward offset time limit violated. |
| 400 | 994 | Invalid Encryption-Algorithm header value |
| 400 | 994 | Invalid Encryption Request Parameters |
| 400 | 994 | Cryptography error |