This API is used to allow or restrict the usage of card for international ATM, POS and/or e-commerce transactions through various channels such as online banking or mobile banking for the specified duration in the designated countries. The Credit+ Issuing system receives, validates and processes the request. If the request is successful, international usage is allowed/restricted on the card, system 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 whetherthe 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:
1. 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).
2. 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 | CCRBO0004 | Request processed successfully |
| 201 | HDS0000 | Service request has been processed successfully |
| 400 | 997 | Retail Transaction To Loan Request failed: invalid request |
| 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 | Invalid Device Number field should be numeric. |
| 400 | 997 | Device Number field value must have min length 10. |
| 400 | 997 | Device Number field value must have max length 24. |
| 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 | Operation field is mandatory. |
| 400 | 997 | Operation field is invalid. |
| 400 | 997 | Activation Type field is mandatory. |
| 400 | 997 | Activation Type field is invalid. |
| 400 | 997 | Activation Type is not allowed for Deactive operation '0'. |
| 400 | 997 | Transaction mode is not allowed for Deactive operation '0'. |
| 400 | 997 | Transaction country is not allowed for Deactive operation '0'. |
| 400 | 997 | Device Number field should be numeric. |
| 400 | 997 | Card Number Alias field should be alphanumeric with only allowed special characters are [_!'()*+,-.]. |
| 400 | 997 | Card Number Alias field value must have max length 24. |
| 400 | 997 | Device Number field should be numeric. |
| 400 | 997 | Card Number Alias field should be alphanumeric with only allowed special characters are [_!'()*+,-.]. |
| 400 | 997 | Either Device Number or Card Number Alias field must be present. |
| 400 | 997 | Time in Hrs is not allowed for Deactive operation '0'. |
| 400 | 997 | Start Date is not allowed for Deactive operation '0'. |
| 400 | 997 | End Date is not allowed for Deactive operation '0'. |
| 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 is not allowed for Activation Type - 'Activation in Period'. |
| 400 | 997 | Start Date field is mandatory. |
| 400 | 997 | End Date field is mandatory. |
| 400 | 997 | Start Date field must be in MM/dd/yyyy format. |
| 400 | 997 | End Date field must be in MM/dd/yyyy format. |
| 400 | 997 | Time in Hrsis not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | Start Date is not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | End Date is not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | Transaction Mode is not allowed for Activation Type - 'Life Long Activation'. |
| 400 | 997 | Transaction Mode is not allowed for Activation Type - 'Time in Hrs'. |
| 400 | 997 | Transaction Mode is invalid. |
| 400 | 997 | Transaction Mode field is mandatory. |
| 400 | 997 | Transaction Country field is mandatory. |
| 400 | 997 | Country code {} is invalid. |
| 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 |
| 500 | CNA006 | Error while fetching device details |
| 400 | 927 | Invalid Country |
| 400 | 998 | DEVICE_ERROR |
| 500 | INT101 | Error while retrieving 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 de-activated |
| 400 | HDE260 | DEVICE is already activated for life long use |
| 400 | HDE261 | DEVICE is already activated for |
| 400 | HDE262 | Device activated for a specific period for same transaction mode and transaction country |
| 400 | HDE264 | Only Activated DEVICE can be De-Activate |
| 400 | HDS455 | Duplicate configuration received |
| 400 | 994 | Invalid Request - Unrecognized field. |
| 400 | 988 | Encryption type Not Supported. |
| 400 | 913 | Forward offset time limit violated. |
| 500 | HDE417 | Error while processing request |
| 500 | BTHCM00018 | Error while processing request |
| 500 | 913 | Backward offset time limit violated. |
| 400 | 994 | Invalid Encryption-Algorithm header value |
| 400 | 994 | Invalid Encryption Request Parameters |
| 400 | 994 | Cryptography error |