Card Activation

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/cardholder/cardactivation

Credit + Issuing system will receive the Card Activation API request call and responds back with the Card Activation API response.
If the response issuccessful, then device number/ Pack ID given in request will be activated. Else, appropriate message will be displayed. For this API, Device plan Activation mode will be “MANUAL”. For any other mode the activation request will be rejected. For this API, If in Device plan “PIN Data Transmission” is set as “PIN Via SMS” and “Card Activation - API” is selected in “PIN via SMS triggering events”, then clear PIN will be sent to cardholder on registered mobile number after successful card activation. If the system is not able to send the clear PIN due to an internal error, then original card activation request will not have any impact. Card Activation API will be applicable for personalized/non-personalized devices. In case of paired cards, only Primary Device will be activated. This API will not activate Paired Device.

NOTE: The 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 = UPGRADE (9) AND UPGRADE_STATUS = 1).

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	Description
400	400	Request Parameters Validation Failure: Invalid Request
201	404	Device(s) does not exist
201	500	Request processing error
201	VALFRM028	Invalid Device Number
201	VALFRM029	Invalid Device Plan
201	VALFRM040	Not allowed for Virtual Cards
201	VALFRM030	Device is already Activated
201	VALFRM031	Device is Cancelled
201	VALFRM032	Device is Replaced
201	VALFRM034	Device is Expired
201	VALFRM037	Error while accessing stoplist data
201	VALFRM038	Device is stoplisted
201	VALFRM033	Device is not Normal
201	VALFRM035	Device is not Delivered
201	VALFRM036	Device is not Registered
201	VALFRM039	Device cannot be activated as activation mode is not configured as manual.
201	ACTDEV004	Invalid Card Pack ID
201	ACTDEV005	Invalid Device Number
201	ACTDEV006	Invalid Program
201	ACTDEV001	Invalid Transaction Code
201	ACTDEV003	Failed when updating device
201	ACTDEV002	Log statement request is failed due to internal error. Please contact system admin.
201	VALFRM003	Invalid Device
201	VALFRM005	Invalid Card Pack ID
201	VALFRM007	Invalid form factor type
400	997	Only alphanumeric characters and underscore are allowed
400	997	Form Factor field value must have min length 10.
400	997	Form Factor field value must have max length 24
400	997	Device Plan 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	Program Code field value must have max length 10.
400	997	Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Product Type field is invalid.
400	CNA001	Bank Does Not Exists
400	CNA002	Card number Alias functionality is not applicable for this institution.
400	CNA003	Record does not exist for the given details
400	CNA005	Multiple device number are active for given details
400	CNA006	Error while fetching device details.
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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

formFactorType

string

enum

required

length ≤ 3

Identifies if it is a Card Number (CRD), Card Pack ID (CPI), or Card Number Alias (CNA). Not NULL. Must be CRD, CPI, or CNA. Maximum length: 3.

Allowed:

formFactor

string

required

length between 10 and 24

^[a-zA-Z0-9]{10,24}$

Card Number, Card Pack ID, or Card Number Alias. Not NULL. Minimum length: 10 (not applicable for CNA). Maximum length: 24.

channel

string

required

Network Code associated to Acquirer ID.

productType

string

enum

length ≤ 1

Product type of Device. Must be P (Pre-paid), C (Credit), or D (Debit). Required only when formFactorType is CNA and multiple devices are linked with same CNA.

Allowed:

programCode

string

length ≤ 10

^[a-zA-Z0-9_]{1,10}$

Program attached to the device. Alphanumeric. Maximum Length: 10. Required only when formFactorType is CNA and multiple devices are linked with same CNA.

devicePlanCode

string

length ≤ 10

^[a-zA-Z0-9_]{1,10}$

Device Plan Code attached with the device. Alphanumeric. Maximum Length: 10. Required only when formFactorType is CNA and multiple devices are linked with same CNA.

timestamp

string

required

^[0-9]+$

Current UTC timestamp in milliseconds. Numeric. AES key expiration criteria depends on input UTC timestamp. Applicable only for encrypted requests.

Headers

Correlation-ID

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.

Encryption-Algorithm

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:

Source

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

201Card activated successfully