Card Replacement Request API

The request for Card Replacement Request API is received from a third-party channel (netbanking/mobile banking).
The system will first validate and then processthe request. Once the validations are passed, the system creates a ‘Replace/Upgrade Device Request’ service request and sends the service request details in the response message.
NOTE: This API, if sent with Card Number Alias (CNA), will fetch the corresponding associated device for further processing only if DEVICE STATUS_CODE = NORMAL (0) or DEVICE STATUS_CODE = EXPIRED (12).

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 CodeError CodeReason
201HDS000Request processed successfully.
400997Device Number field is mandatory.
400997Device Number field should be numeric.
400997Priority Request field is invalid.
400997Request Date field is mandatory.
400997Request Date field must be in MM/dd/yyyy HH:mm:ss format.
400997Reason field is mandatory.
400997New Card Number field value must be '1'
400997New Card Number field value must be '0'
400997New Card Number field is mandatory.
400997New Card Number field is invalid.
400997Replacement Fees field is mandatory.
400997Replacement Fees field is invalid.
500999Internal error.
400997Request Date should be less than or equal to institution date.
400CR200Invalid reason Code.
400CR207Invalid Device number.
400CR209Device plan not found for configured replacement device technology.
400CR210Existing device plan and new device plan are same for reason code.
400CR211Replacement Device Technology is not configured for this device plan.
400100Bank is not specified.
400102Device number does not exist.
400104Device belongs to different Product.
400135Replacement is not allowed as Device is not sold
400190Replacement is not allowed on limited virtual validity device.
400136Replaced Device.
400106Inactive DEVICE.
400107Cancelled DEVICE.
400109Device In Production.
400139Paired device present. Please use Activate Paired Device service request to activate the paired device.
400145Device is already replaced, or its pair card is already activated.
400146Replacement not allowed for this device because Paired card of this device is already replaced.
400998Invalid device number.
400STPLST006Invalid reason code.
400HDE120Withdrawal Denied due to sticky reason code.
500913Backward offset time limit violated.
400994Invalid Request - Unrecognized field.
400988Encryption type Not Supported.
400913Forward offset time limit violated.
400APPUP00315Embossed Name must be an alphanumeric value, may contain spaces or periods and field length should be between 2-26.
400APPUP00299Add-On Embossed name should not contain any special characters other than spaces, periods and field length should be between 2-26.
400BRCHCD001Invalid Branch Code.
400APPUP00105Branch code does not exist.
400994Invalid Encryption-Algorithm header value
400994Invalid Encryption Request Parameters
400994Cryptography error
400997Numberless Card field is invalid
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

string
enum
required

API Consumer must share Encryption-Algorithm as a key (value: DES168) in HTTP header in order to encrypt the API requests.

Allowed:
string

API Consumer can share Source in HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json