Add-On Card API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/helpdesk/addoncard

This API is used to request for add-on card applications through various channels such as, online banking or mobile banking, or any issuer’s applications.
The Credit+ Issuing system receives, validates, and processesthe request. If the request is successful, the system logs the log only ‘Add-on Card Request’ (Service Code: 102) service request (SR). Based on the bank's decision, the bank user hasto raise the Add-on card SR, or add-on card application through customer portal screens to create the add-on card.
The service request number is sent in the response message. If the request fails, the system returns the corresponding error code in the response and the SR is not logged.
Once the system logs the Add-on Card service request (SR 102) and the escalation matrix (maker and checker) is configured for the SR, the service requestshall always be in Open Status. The service request is then not available in the checker queue for approval.
Once the system logs the Add-on Card service request (SR 102) and the escalation matrix (maker and checker) is not configured for the SR, the service request shall be marked as resolved.

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	HDE000	Request processed successfully
201	CCRBO0004	Request processed successfully
400	913	Backward offset time limit violated.
400	913	Forward offset time limit violated.
400	994	Invalid Request - Unrecognized field.
400	997	Device Number field is mandatory
403	900	Device Number field should be numeric.
404	998	Invalid Priority Request
404	988	Encryption type Not Supported.
500	999	Invalid Request Type
400	997	Request Date field is mandatory
400	997	Request Date must be in MM-DD-YYYY HH:MM:SS format.
400	997	Title field is mandatory
400	997	First Name field should be alphanumeric and may contain space.
400	997	Last Name field is mandatory. First Name field is mandatory.
400	997	Last Name field should be alphanumeric and may contain space.
400	997	Embossed Name field is mandatory.
400	997	Embossed Name field should be alphanumeric and may contain space.
400	997	Embossed name should not contain any special characters other than spaces, periods and field length should be between 2-26
400	997	Relation field is mandatory.
400	997	First Name field is Birth Date must be in MM-DD-YYYY format.
400	997	Request Date should be less than or equal to institution date.
400	997	Birth Date should be less than institution date.
400	997	Alternate Name field value must have max length 200.
400	997	Embossing Line4 field should not contain any special characters otherthan spaces, periods, and field length should be between 2-26.
400	997	Registered Mobile Number field is mandatory.
400	997	Registered Mobile Number field should be numeric.
400	997	Registered Mobile Number field value must have max length 15.
400	997	ISD Code field is mandatory.
400	997	ISD Code field value must have max length 6.
400	997	Registered e-mail ID field is mandatory.
400	997	Registered e-mail ID field must be a valid email id.
400	997	Registered e-mail ID field value must have max length 50.
400	997	Preferred Language field is invalid.
400	997	Marital Status field is invalid.
400	997	Marital Status field is mandatory.
400	997	Country Code field is mandatory.
400	997	Country Code field value must have max length 3.
400	997	AddressLine1 field is mandatory.
400	997	AddressLine1 field value must have max length 150.
400	997	AddressLine1 field should only contain [a-z A-Z 0-9], SPACES and special characters [.,&#:*()-] and must start with an alphanumeric character.
400	997	AddressLine2 field value must have max length 150.
400	997	AddressLine2 field should only contain [a-z A-Z 0-9], SPACES and special characters [.,&#:*()-] and must start with an alphanumeric character.
400	997	AddressLine3 field value must have max length 150.
400	997	AddressLine3 field should only contain [a-z A-Z 0-9], SPACES and special characters [.,&#:*()-] and must start with an alphanumeric character.
400	997	AddressLine4 field value must have max length 150.
400	997	AddressLine4 field should only contain [a-z A-Z 0-9], SPACES and special characters [.,&#:*()-] and must start with an alphanumeric character.
400	997	Preferred Mailing Address field is invalid.
400	997	Preferred Mailing Address field is mandatory.
400	997	Credit Limit field must be a positive value with maximum 12 integers and 7 fractions.
400	997	Cash Limit field must be a positive value with maximum 12 integers and 7 fractions.
400	997	Credit Limit field is invalid.
400	997	Cash Limit field is invalid.
400	997	Preferred Mailing Address field is mandatory
400	997	Instant Card Flag field is invalid.
400	998	NO_DEVICE_ERROR
400	AD102	Invalid Title.
500	AD103	Error while getting title details
400	AD104	Invalid Relation
500	AD105	Error while getting Relation details
500	AD107	Error while getting Device Plan details.
400	AD106	Device Plan not present for given program attached to device
400	AD108	Invalid Picture code
500	AD109	Error while getting Picture code details
400	AD110	Invalid Gender code
500	AD112	Error while executing Add on Card replace through AP
400	AD113	Length of First name should be less than 100
400	AD113	Length of Last name should be less than 100.
400	AD102	Demographic Fetch issue.
400	AD123	Credit limit is lessthan the limit defined at the program.
400	AD124	Cash limit is more than the limit defined at the program.
400	AD125	Credit limit is mandatory if cash limit is given.
400	AD126	Cash limit must be equal to program fixed cash limit.
400	AD127	Cash limit must be greater than product minimum cash limit.
400	AD128	Cash limit must be less than product maximum cash limit.
400	AD121	Invalid Branch limit.
400	AD130	Credit/Cash limit for Prepaid/Debit card should be blank.
400	AD133	Invalid value - Zip Code
400	AD201	Client Code is not valid.
400	AD228	Invalid device type.
400	APPOB0001	Onboarding is not allowed on Device Plan: [Device plan code related to the device].
400	PRC001	Provided Credit limit is greater than Card Credit limit
400	PRC002	Provided Cash limit is greater than card cash limit
400	PRC003	Cash limit should be less than credit limit
400	PRC004	Insufficient branch level limit
400	PRC100	Error, Validation at cr card balance details
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
400	SERVIC001	Service request is not applicable to product type.
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

deviceNumber

string

required

length ≤ 24

^[0-9]+$

Card number. Numeric, not null, maximum length 24.

priorityRequest

string

enum

Denotes whether the request is to be taken on priority or not. Valid values are 0 for no priority, 1 for priority request.

Allowed:

note

string

length ≤ 4000

Any free text that requestor may want to send for logging purpose. Maximum length 4000.

channel

string

length ≤ 10

Accessing channel. Maximum length 10.

requestDate

string

required

^(0[1-9]|1[0-2])/(0[1-9]|[12][0-9]|3[01])/([0-9]{4}) ([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Denotes the date and time of request in MM/DD/YYYY HH:MM:SS format. Must be less than or equal to the institution date.

title

string

enum

required

length ≤ 30

Title of the cardholder. Valid values are 1: Mr., 2: Mrs., 3: Miss., 4: Dr., 5: Chief, 6: Sir, 7: Ms. Maximum length 30.

Allowed:

firstName

string

required

length ≤ 100

^[A-Za-z0-9][A-Za-z0-9\'\-. & ]*$

First name of the cardholder. Can contain A-Z, a-z, 0-9, space, ', -, ., &. Must start with alphanumeric. Maximum length 100.

lastName

string

required

length ≤ 100

^[A-Za-z0-9][A-Za-z0-9\'\-. & ]*$

Last name of the cardholder. Can contain A-Z, a-z, 0-9, space, ', -, ., &. Must start with alphanumeric. Maximum length 100.

embossedName

string

length ≤ 26

^[A-Za-z0-9 .]+$

Name to be embossed on card. Alphanumeric, can contain spaces and periods. Maximum length 26.

alternateName

string

length ≤ 200

Cardholder's alternate name to be accepted in any language. Maximum length 200.

birthDate

string

^(0[1-9]|1[0-2])/(0[1-9]|[12][0-9]|3[01])/([0-9]{4})$

Birth date of cardholder in MM/DD/YYYY format. Must be less than the institution date if present.

relation

string

enum

required

length ≤ 30

Relation of the add-on cardholder with the primary client. Valid values are M: Mother, B: Brother, D: Daughter, F: Father, O: Others, S: Sister, SO: Son, SP: Spouse, FIL: Father-In-Law, MIL: Mother-In-Law, Business card. Maximum length 30.

pictureCode

string

length ≤ 30

Picture code defined in institution parameter setup. Maximum length 30.

devicePlan

string

length ≤ 10

^[A-Za-z0-9]+$

Type of plan assigned to the device. Alphanumeric, maximum length 10.

gender

string

enum

length ≤ 2

Gender of cardholder. Valid values are M: Male, F: Female, R: Not Reported. Maximum length 2.

Allowed:

maritalStatus

string

enum

required

length ≤ 1

Marital status of the add-on cardholder. Valid values are 0: Single, 1: Married, 2: Divorcee, 3: Widow/Widower. Length 1.

Allowed:

creditLimit

double

0 to 1000000000000

Credit limit for credit products, mandatory for credit products. Integer length 12, fraction 7. Must be between program/branch min/max limits, less than or equal to primary card credit limit. No negative or blank values for credit products. Not applicable for debit/prepaid products.

cashLimit

double

0 to 1000000000000

Cash limit for credit products, mandatory for credit products. Integer length 12, fraction 7. Must be between program/branch min/max limits, less than or equal to primary card cash limit and own credit limit. No negative or blank values for credit products. Not applicable for debit/prepaid products.

preferredMailingAddress

string

enum

length ≤ 1

Add-on cardholder’s preferred mailing address. Valid values are C: Current, P: Permanent, O: Office. Length 1. Defaults to primary cardholder’s address if no valid value provided.

Allowed:

addressLine1

string

length ≤ 150

^[A-Za-z0-9][A-Za-z0-9 ,&\#:*\{\}\$+;\'\\/-]*$

Address line one of the add-on cardholder. Mandatory if preferredMailingAddress is C, P, or O. Can contain A-Z, a-z, 0-9, space, ., ,, &,

addressLine2

string

length ≤ 150

^[A-Za-z0-9][A-Za-z0-9 ,&\#:*\{\}\$+;\'\\/-]*$

Address line two of the add-on cardholder. Mandatory if preferredMailingAddress is C, P, or O. Can contain A-Z, a-z, 0-9, space, ., ,, &,

addressLine3

string

length ≤ 150

^[A-Za-z0-9][A-Za-z0-9 ,&\#:*\{\}\$+;\'\\/-]*$

Address line three of the add-on cardholder. Mandatory if preferredMailingAddress is C, P, or O. Can contain A-Z, a-z, 0-9, space, ., ,, &,

addressLine4

string

length ≤ 150

^[A-Za-z0-9][A-Za-z0-9 ,&\#:*\{\}\$+;\'\\/-]*$

Address line four of the add-on cardholder. Mandatory if preferredMailingAddress is C, P, or O. Can contain A-Z, a-z, 0-9, space, ., ,, &,

country

string

length ≤ 3

^[0-9]{3}$

Three-digit ISO country code. Mandatory if preferredMailingAddress is C, P, or O. Defaults to primary cardholder’s country if no value provided. Length 3.

postalCode

string

length ≤ 10

^[0-9]+$

Postal code of the add-on cardholder. Numeric, maximum length 10. Mandatory if preferredMailingAddress is C, P, or O. Must match institution-configured values or error is returned. Defaults to primary cardholder’s postal code if no value provided.

mobileISDCode

string

required

length ≤ 6

^\+[0-9-]+$

ISO country code with plus sign, e.g., +91, +1-829, +1-809. Alphanumeric with special characters, maximum length 6.

registeredMobileNumber

string

required

length ≤ 15

^[0-9]+$

Valid mobile number. Numeric, maximum length 15.

registeredemailID

string

required

length ≤ 50

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Valid email address. Alphanumeric with special characters, maximum length 50.

preferredLanguage

string

enum

length ≤ 2

Applicant’s preferred language. Valid values are en: English, th: Thai, ar: Arabic. Two-character code, lowercase only. Defaults to primary cardholder’s language if no valid value provided.

Allowed:

instantCardFlag

string

enum

length ≤ 1

Flag indicating whether instant card is to be generated. Valid values are Y, N, or blank. Ignored if not enabled at institution level. Length 1.

Allowed:

embossingLine4

string

length ≤ 26

^[A-Za-z0-9 .]+$

Corporate name for embossing, shown or printed on the card. Alphanumeric with spaces and periods, length 2-26. Captured as blank if relation is not 'Business card' and no value provided.

timestamp

string

required

^[0-9]+$

Current UTC timestamp in milliseconds. Numeric, used for AES key expiration in 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

201Successful add-on card request