post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/cardholder/customerboardingprepaid
This API is used for personalized card issuance. It supports instant card (Instant Card flag: Y) as well as standard physical card issuance process. It is applicable for prepaid productsissued on Pine Labs platform. Using this API, the institution user can configure upto 15 wallets and promotion plan for each wallet.
NOTE: The embossing files will not get generated for the customer registration request applications where the Instant Card flag is 'Y'. The bank needs to call GET Emboss details API that will send standard information required for instant card embossing.
Card Number Alias (CNA) processing logic- Institution level uniqueness
- If the system locates a device with status code as Normal (0), then that device is used for processing the request.
- If the CNA is linked to multiple devices with status code as Normal (0), the request is rejected.
- If the system does not find any device with status code as Normal (0), then the system tries to search the CNA at institutional level. If found, the latest device (based on Opening Date and Date Create) linked to the CNA is used for further processing the request.
- Ifthe latest device isfound as Replaced, then the system searchesfor the updated device to process the request.
Card Number Alias (CNA) processing logic- Device level uniqueness
- If the system locates a device with status code as Normal (0), then that device is used for processing the request.
- If the CNA is linked to multiple devices with status code as Normal (0), the request is rejected.
- If the system does not find any device with status code as Normal (0), the system tries to search the CNA at institutional level.
- If the uniqueness is configured at device plan level, then the system checks if the Existing Device Plan Code and Existing Program Code fields are present in the API request. Else the request is rejected.
- If the Existing Device Plan Code and Existing Program Code fields are present in the API request, the system tries to locate the CNA linked to a latest device. If found, the latest device (based on Opening Date and Date Create) linked to the CNA is used for further processing the request.
- Ifthe latest device isfound as Replaced, then the system searchesfor the updated device to process the request.
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 |
|---|---|---|
| 403 | 900 | User Or Bank does not support API |
| 400 | 997 | All the errors correspond to 997 error code will be field validations error like length validation error, mandatory validation error, data type validation error (alphanumeric or numeric or alphanumeric with space or any other regular expression), Date format, validation error and so on. NOTE: Please refer API parameter specifications for field name. Sample messages: Mandatory: field is mandatory. length: field value must have max length . alphanumeric with spaces: field should be alphanumeric and may contain space. alphanumeric: field should be alphanumeric. Number: field should be numeric. Valid values: field is invalid. Date: field must be in format. Amount: field must be a positive value with maximum integers and fractions. |
| 500 | 999 | Exception occurred while serving the request |
| 500 | 999 | Error while processing request: java.lang.IllegalArgumentException: Unrecognized field |
| 500 | 999 | Internal error |
| 400 | 997 | Branch Code field is mandatory |
| 400 | 997 | Maker Checker Flag field is invalid |
| 400 | 997 | Onboarding is not allowed on Device Plan: [Device plan code related to the device] |
| 400 | APP053 | Error while processing the request |
| 400 | APPUP00100 | Wallet Promotion Plan is Expired |
| 400 | APPUP00101 | Device Plan Code is Mandatory |
| 400 | APPUP00102 | Device Plan does not Exist |
| 400 | APPUP00103 | Device Promotion Plan does not exist |
| 400 | APPUP00104 | Device Photo Indicator does not exists |
| 400 | APPUP00105 | Branch code does Not Exist |
| 400 | APPUP00106 | Corporate Client is mandatory in case of Corporate Program code |
| 400 | APPUP00107 | Corporate program is mandatory in case of Corporate client code |
| 400 | APPUP00108 | Title Is Mandatory |
| 400 | APPUP00109 | Last Name is Mandatory |
| 400 | APPUP00110 | Gender is Mandatory |
| 400 | APPUP00111 | Value for Marital Status is Mandatory |
| 400 | APPUP00112 | Nationality is Mandatory |
| 400 | APPUP00113 | APPLICATION_TYPE CODE Is Not Exist In system codes |
| 400 | APPUP00114 | Birth Date is mandatory |
| 400 | APPUP00115 | Birth date should be less than institution date |
| 400 | APPUP00116 | Invalid Birth date format |
| 400 | APPUP00117 | Invalid birth country |
| 400 | APPUP00118 | Preferred mailing address is mandatory |
| 400 | APPUP00119 | Preferred mailing address should have one of the following values - C: Current, P: Permanent, O: Office |
| 400 | APPUP00120 | CURRENT_ADDRESS_LINE1 is mandatory |
| 400 | APPUP00121 | Current Country /State /City /Zip Code is mandatory |
| 400 | APPUP00122 | Current Country /State /City /Zip Code is Invalid |
| 400 | APPUP00123 | PERMANENT_ADDRESS_LINE1 is mandatory |
| 400 | APPUP00124 | Permanent Country /State /City /Zip Code is mandatory |
| 400 | APPUP00125 | Permanent Current Country /State /City /Zip Code is Invalid |
| 400 | APPUP00126 | Office Address is mandatory |
| 400 | APPUP00127 | Office Country /State /City /Zip Code is mandatory |
| 400 | APPUP00128 | Office Current Country /State /City /Zip Code is Invalid |
| 400 | APPUP00129 | Occupation must be present in the system |
| 400 | APPUP00130 | Register for DNCR flag should be Y or N |
| 400 | APPUP00131 | SMS alert list should be Y or N |
| 400 | APPUP00132 | EMAIL alert list should be Y or N |
| 400 | APPUP00133 | Value for Statement Preference should be E Email/H Hard Copy/B - Both |
| 400 | APPUP00134 | Kyc Required Falg on Program should be Y or N |
| 400 | APPUP00135 | Number of Documents sent in application record is less than Doc. required on program |
| 400 | APPUP00136 | Embossing name is mandatory |
| 400 | APPUP00137 | VIP Flag value is invalid |
| 400 | APPUP00138 | Legal Document is mandatory if Legal Type is mandatory or vice versa |
| 400 | APPUP00139 | Legal Id type is invalid |
| 400 | APPUP00140 | SOME Legal Id is Matched with another Legal Id |
| 400 | APPUP00141 | Legal Id Type is Matched with another Legal Id Type |
| 400 | APPUP00142 | Device is not in Normal State |
| 400 | APPUP00143 | Device Range is either Inactive or Exhausted |
| 400 | APPUP00144 | Wallet is not in Normal State |
| 400 | APPUP00145 | First Name is Mandatory |
| 400 | APPUP00146 | Value for Education must be 0,1,2,3,4,5,6,7,10 |
| 400 | APPUP00147 | Value for Delivery mode must be 0,1,2 |
| 400 | APPUP00148 | Value for Language Preference must be FR, DE, PL, PT, ES, EN |
| 400 | APPUP00149 | Value for legal identification type must be 01,02,03,04,05,06,07,08,09,10 |
| 400 | APPUP00150 | Value for Employment Status must be 0,1,2,3,4,5,6,7 |
| 400 | APPUP00151 | Value for Comp Type must be 0,1,2,3 |
| 400 | APPUP00152 | Value for Applicant Prof must be 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 |
| 400 | APPUP00153 | Value for Residence Status must be 0,1,2,3,4,5,6,7 |
| 400 | APPUP00154 | Value for Owned Vehicle Type must be 0,1,2 |
| 400 | APPUP00155 | Value for Empl Designation must be 0,1,2,3,4,5,6,7,8,9 |
| 400 | APPUP00156 | Value for Other Account Type must be C,D,S |
| 400 | APPUP00157 | Value for Customer Type is Mandatory |
| 400 | APPUP00158 | Mandatory Legal Id Type is missing in file, Check Documnet Checklist plan |
| 400 | APPUP00159 | Client can have only one primary device under same program |
| 400 | APPUP00162 | Value for Legal ID 1 Issuance place is Mandatory |
| 400 | APPUP00163 | Value for Legal ID 2 Issuance place is Mandatory |
| 400 | APPUP00164 | Value for Legal ID 3 Issuance place is Mandatory |
| 400 | APPUP00165 | Value for Legal ID 4 Issuance place is Mandatory |
| 400 | APPUP00166 | Value for Legal id 1 expiry date is Mandatory |
| 400 | APPUP00167 | Value for Legal id 2 expiry date is Mandatory |
| 400 | APPUP00168 | Value for Legal id 3 expiry date is Mandatory |
| 400 | APPUP00169 | Value for Legal id 4 expiry date is Mandatory |
| 400 | APPUP00170 | Invalid Device type/Program |
| 400 | APPUP00171 | For LVC Device type Registered mail Id must be mandatory |
| 400 | APPUP00172 | Value for legal id must not match with other legal id in same application |
| 400 | APPUP00173 | Invalid Device type in file |
| 400 | APPUP00174 | Invalid application type / Sub type |
| 400 | APPUP00175 | Supplementary device is allowed only for existing client |
| 400 | APPUP00176 | Birthdate validation failed |
| 400 | APPUP00177 | Invalid value for Current Zip Code |
| 400 | APPUP00178 | Current Zip Code is mandatory |
| 400 | APPUP00179 | Invalid value for Current City Code |
| 400 | APPUP00180 | Invalid value for Current State Code |
| 400 | APPUP00181 | Permanent Country Code is mandatory |
| 400 | APPUP00183 | Permanent Zip Code is mandatory |
| 400 | APPUP00184 | Invalid value for Permanent City Code |
| 400 | APPUP00185 | Child1 Birth date should be less than institution date |
| 400 | APPUP00186 | Child2 Birth date should be less than institution date |
| 400 | APPUP00188 | Invalid value for Office Zip Code |
| 400 | APPUP00189 | Office Zip Code is mandatory |
| 400 | APPUP00190 | Invalid value for Office City Code |
| 400 | APPUP00191 | Risk category value is invalid, possible values are A/B/C/D/E/F |
| 400 | APPUP00192 | Invalid value for application status, possible values are V,F |
| 400 | APPUP00193 | Add-on mobile number/ISD code is mandatory |
| 400 | APPUP00194 | Email Id is invalid |
| 400 | APPUP00195 | Length of Client Customer ID is invalid |
| 400 | APPUP00196 | Client Customer ID not matched with existing Client |
| 400 | APPUP00197 | Direct_Debit_Account_Name is mandatory |
| 400 | APPUP00198 | Direct_Debit_Account_Number is mandatory |
| 400 | APPUP00199 | Direct_Debit_Account_Type is mandatory |
| 400 | APPUP00200 | Direct_Debit_Branch is mandatory |
| 400 | APPUP00201 | Direct_Debit_Percentage is mandatory |
| 400 | APPUP00202 | Direct Debit Percentage should be positive /less than equal to 100 |
| 400 | APPUP00203 | Reference mobile number/ISD code is mandatory |
| 400 | APPUP00204 | Reference ISD code is invalid |
| 400 | APPUP00205 | Office mobile number/ISD code is mandatory |
| 400 | APPUP00206 | Office ISD code is invalid |
| 400 | APPUP00207 | Registered mobile number/ISD code is mandatory |
| 400 | APPUP00208 | Registered ISD code is invalid |
| 400 | APPUP00209 | Addon ISD code is invalid |
| 400 | APPUP00211 | Existing Device Number is mandatory |
| 400 | APPUP00212 | Existing Client Code is mandatory |
| 400 | APPUP00213 | Existing Device Number / Primary Application number is mandatory |
| 400 | APPUP00214 | Existing Addon Client Code is mandatory |
| 400 | APPUP00215 | Device is already created against this application, enter only existing device number to continue |
| 400 | APPUP00216 | Invalid value for Current Country Code |
| 400 | APPUP00217 | Invalid value for Permanent Country Code |
| 400 | APPUP00218 | Invalid value for Office Country Code |
| 400 | APPUP00219 | Photo Code is Mandatory |
| 400 | APPUP00220 | Invalid value for Nationality (Country Code) |
| 400 | APPUP00221 | Invalid Marital Status, Not Exist in SYSTEM_CODES |
| 400 | APPUP00223 | If value for Email Alert List is Y then Registered mail Id is mandatory |
| 400 | APPUP00227 | Value for Program Code is mandatory |
| 400 | APPUP00228 | Value for Branch code is mandatory |
| 400 | APPUP00229 | Value for Application Type is mandatory |
| 400 | APPUP00230 | Value for Application Sub Type is mandatory |
| 400 | APPUP00231 | Value for Product Type is mandatory |
| 400 | APPUP00232 | Device type 1 is mandatory |
| 400 | APPUP00233 | Device Photo Indicator1 is mandatory |
| 400 | APPUP00234 | Invalid device photo indicator for selected device type |
| 400 | APPUP00237 | Invalid billing cycle code |
| 400 | APPUP00242 | Picture Code is required for this combination Program Code and Photo Indicator [2] |
| 400 | APPUP00244 | Language preference is Mandatory |
| 400 | APPUP00251 | Invalid Event based fee code |
| 400 | APPUP00252 | Invalid Maintenance based fee code |
| 400 | APPUP00253 | Invalid wallet fee plan code |
| 400 | APPUP00254 | Multiple Primary/Addon for same Program ID are not allowed |
| 400 | APPUP00255 | Existing client code not present |
| 400 | APPUP00256 | Existing client code is add on client |
| 400 | APPUP00257 | Permanent Promo plan code not exist in system |
| 400 | APPUP00258 | Add on relation is mandatory |
| 400 | APPUP00259 | Invalid direct debit flag |
| 400 | APPUP00260 | Add on Embossed name is mandatory |
| 400 | APPUP00261 | Invalid Direct debit amount flag/Account type is not present |
| 400 | APPUP00262 | Invalid Direct debit amount flag |
| 400 | APPUP00263 | Invalid Add on relation |
| 400 | APPUP00264 | Program Code does not exist |
| 400 | APPUP00268 | Office Email Id is invalid |
| 400 | APPUP00269 | Invalid Addon Gender |
| 400 | APPUP00270 | Nominee Email Id is invalid |
| 400 | APPUP00271 | Addon Email Id is invalid |
| 400 | APPUP00274 | Device plan code is invalid |
| 400 | APPUP00275 | Invalid Existing Device Number |
| 400 | APP001 | Caught in Dedupe. /SDN matching |
| 400 | APP00161 | Corporate client code should be blank for non corporate application |
| 400 | APP00162 | Customer type should not be corporate for Addon application |
| 400 | APP00163 | Corporate issuance is not allowed to Add-on |
| 400 | APP002 | Error while processing Dedupe. /SDN matching |
| 400 | APP003 | Existing Addon Client Code is mandatory |
| 400 | APP004 | Existing Client Code is Invalid / Not in normal status |
| 400 | APP005 | Invalid Corporate Client Code |
| 400 | APP006 | Either Existing Device Number or Primary application Number is mandatory |
| 400 | APP007 | Existing Device Number is Invalid /Not in Normal Status/ Expired |
| 400 | APP008 | Error While Processing Application |
| 400 | APP011 | Instant card not supported for this institution |
| 400 | APP012 | Card PACK ID Range is exhausted. /Card Range exhausted |
| 400 | APP013 | Error in sequence number generation |
| 400 | APP014 | Card generation failed as IPK certificate expired |
| 400 | APP015 | Error card number generation, Maximum 9 Add-on devices are permitted in base device |
| 400 | APP016 | Device range not defined for the selected Branch, Program, Device Plan, and Network./Sequence number ,max and min range must be present |
| 400 | APP017 | CARD PACK ID GENERATED WITH INVALID CARD NUMBER LENGTH. /Device generated with invalid length |
| 400 | APP019 | Please check Device Range. Issuer Bin is null for device RANGE |
| 400 | APP020 | Client is ALREADY having any primary/secondary device of applied product |
| 400 | APP021 | Client should not have any device of selected program |
| 400 | APP022 | Device generated is Stop listed. /Error card pack id generation, Check Card Pack id generation template |
| 400 | APP023 | Device Type and Device Plan - Combination should be unique always |
| 400 | APP024 | Mobile number is mandatory if device type is selected as Mobile |
| 400 | APP025 | Existing Client Code is InActive / Not registered |
| 400 | APP027 | Mobile device type allowed only once per application, request declined |
| 400 | APP028 | Entered Mobile number is already used. Please user other mobile number |
| 400 | APP029 | Invalid Picture Code |
| 400 | APP030 | Error While Validating Business Mandatory fields Incomplete Application |
| 400 | APP031 | Error while processing Application (Technical Reason, Check Configuration) |
| 400 | APP032 | For Generating Card Pack ID Program code or Free Text must be present in template |
| 400 | APP033 | Error in Card Pack Id generation. Please check logs |
| 400 | APP034 | Invalid Primary Application Number |
| 400 | APP035 | Error card number generation, Please check device id generation template |
| 400 | APP036 | Error in Device generation. Please check logs |
| 400 | APP043 | Supplementary Card Issuance Allowed for Primary Clients Only |
| 400 | APP100 | Duplicate application Id |
| 400 | APP126 | Existing client is already KYC compliant/Check KYC status of Program |
| 400 | APPCRLMT02 | Cash Limit is less than the Limit defined at the Branch |
| 400 | APPCRLMT03 | Cash Limit is more than the Limit defined at the Branch |
| 400 | APPCRLMT04 | Credit Limit is less than the Limit defined at the Branch |
| 400 | APPCRLMT05 | Credit Limit is more than the Limit defined at the Branch |
| 400 | APPCRLMT06 | Cash Limit should be less than maximum credit limit at the branch |
| 400 | APPCRLMT07 | Cash Limit should be less than credit limit |
| 400 | APPCRLMT08 | Credit limit is less than the limit defined at the program |
| 400 | APPCRLMT09 | Credit limit is more than the limit defined at the program |
| 400 | APPCRLMT10 | Credit limit is mandatory if cash limit is given |
| 400 | APPCRLMT11 | Cash limit must be equal to program fixed cash limit |
| 400 | APPCRLMT12 | Cash limit must be greater than product minimum cash limit |
| 400 | APPCRLMT13 | Cash limit must be less than product maximum cash limit |
| 400 | CRDUPL001 | Invalid Device Identifier |
| 400 | CRDUPL002 | Invalid Device Identifier |
| 400 | CRDUPL003 | Account number and account type is Mandatory for Primary device request |
| 400 | CRDUPL004 | Office E-mail ID not present |
| 400 | CRDUPL005 | Device Picture indicator not available |
| 400 | CRDUPL006 | Invalid Nationality |
| 400 | CRDUPL007 | Primary device number is Mandatory for supplementary and add on device |
| 400 | CRDUPL008 | Invalid Account type |
| 400 | CRDUPL009 | Invalid Device Identifier type |
| 400 | CRDUPL010 | Branch Code is mandatory for primary device |
| 400 | CRDUPL011 | For Pre-generated device Delivery Flag should be one |
| 400 | CRDUPL013 | Corporate client code is mandatory |
| 400 | CRDUPL014 | Account already linked to different client |
| 400 | CRDUPL015 | For Individual/Bank staff customer program should not be corporate program |
| 400 | CRDUPL016 | Customer Type should be in 0,1 or 2 |
| 400 | CRDUPL017 | Program should be Corporate program |
| 400 | CRDUPL018 | Invalid corporate client code |
| 400 | CRDUPL019 | Permanent E-mail ID not present |
| 400 | CRDUPL020 | Device Photo indicator not available |
| 400 | CRDUPL021 | Delivery Date is not present |
| 400 | CRDUPL022 | Error in selection SDN_PLAN |
| 400 | CRDUPL023 | Error in selection SDN_PLAN |
| 400 | CRDUPL024 | Error while processing request |
| 400 | CRDUPL031 | Error in institution selection |
| 400 | CRDUPL032 | Error in institution selection |
| 400 | CRDUPL033 | Account number length not as per length defined at Institution level |
| 400 | CRDUPL034 | Error in institution selection |
| 400 | CRDUPL035 | Error in institution selection |
| 400 | CRDUPL036 | Client number length not as per length defined at Institution level |
| 400 | 162 | Program Code already Exist for respective Client |
| 400 | BTHUP00111 | Client Code is not present |
| 400 | PROMPU0104 | Promo Plan Not Exits |
| 400 | HDE602 | Client of this device is not registered |
| 400 | FDDP0001 | First Name of New Client cannot be blank |
| 400 | FDDP0002 | CURRENT ADDRESS of New Client cannot be blank |
| 400 | FDDP0038 | Device details are invalid. Error when existing client and device details are incorrect |
| 400 | FDDP0039 | Client Code is not valid. Error when existing client and client details are incorrect |
| 400 | FDDP0040 | Add-on Client code cannot be blank. Error when existing client request type is add-on and existing add-on client code is null |
| 400 | APPUP00315 | Embossed Name must be an alphanumeric value, may contain spaces or periods and field length should be between 2-26 |
| 400 | APPUP00299 | Add-on Embossed Name should not contain any special characters other than spaces, periods and field length should be between 2-26. Error when embossed name is not null, length less than 2, alphanumeric and special characters as [space] and [dot] for add-on cards |
| 400 | ISE40000 | Mandatory field validation failed |
| 400 | 997 | Per Transaction Limit field should be numeric |
| 400 | 997 | Per Transaction Limit field value must have maxlength 20 |
| 400 | 997 | Velocity field value must have maxlength 6 |
| 400 | 997 | Velocity field should be numeric |
| 400 | 997 | Total transaction Limit field should be numeric |
| 400 | 997 | Total transaction Limit field value must have maxlength 20 |
| 400 | 997 | Expiry Date Field value must be size 6 or 7 in DDHHMI or DDDHHMI (Days, hours and minutes) format. Max DDD value is 999, max HH value is 23 and max MI value is 59 |
| 400 | 997 | Per Transaction Limit is not allowed for Device Type other than type 8 |
| 400 | 997 | Velocity is not allowed for Device Type other than type 8 |
| 400 | 997 | Total Transaction Limit is not allowed for Device Type other than type 8 |
| 400 | 997 | Expiry Date is not allowed for Device Type other than type 8 |
| 400 | 997 | clientCustomerID field value must have max length 20 |
| 400 | 997 | clientCustomerID field should be alphanumeric |
| 400 | 997 | Application Type field is invalid |
| 400 | 997 | Existing Card Number Alias field is not allowed with Existing Device Number or for New Primary application type |
| 400 | 997 | Existing Add-On Card Number Alias field is not allowed with Existing Add-On Client Code or allowed for Existing Add-On application type only |
| 400 | 997 | Either Existing Device Number or Existing Card Number Alias field is mandatory |
| 400 | 997 | Either Existing Add-on Client Code or Existing Add-On Card Number Alias field is mandatory |
| 400 | 997 | Existing Card Number Alias field should be alphanumeric |
| 400 | 997 | Existing Card Number Alias field value must have max length 24 |
| 400 | 997 | Existing Add on Card Number Alias field should be alphanumeric |
| 400 | 997 | Existing Add On Card Number Alias field value must have max length 24 |
| 400 | 997 | Existing Program Code field should be alphanumeric. Underscore are allowed and must start and end with an alphanumeric character |
| 400 | 997 | Existing Device Plan Code field should be alphanumeric. Underscores are allowed and must start and end with an alphanumeric character |
| 400 | 997 | Existing AddOn Program Code field should be alphanumeric. Underscore are allowed and must start and end with an alphanumeric character |
| 400 | 997 | Existing AddOn Device Plan Code field should be alphanumeric. Underscores are allowed and must start and end with an alphanumeric character |
| 400 | 997 | Existing Program Code field value must have max length 10 |
| 400 | 997 | Existing Device Plan Code field value must have max length 10 |
| 400 | 997 | Existing AddOn Program Code field value must have max length 10 |
| 400 | 997 | Existing AddOn Device Plan Code field value must have max length 10 |
| 400 | APP050 | Supplementary Card Issuance Allowed For Primary Clients Only |
| 400 | APP051 | Wallet is in Freeze or closed status |
| 400 | APP052 | Existing Device Number is not in Valid status |
| 400 | APP055 | Existing CNA applicable only for Prepaid product |
| 400 | APPUP00309 | Either Existing Device number or Existing Card number Alias should be present |
| 400 | APPUP00310 | Either Existing Add on Client code or Existing Add on Card number Alias should be present for application type 5 |
| 400 | CNA001 | Error While processing request |
| 400 | CNA003 | No Data Found |
| 400 | CNA005 | Too many Devices for CAN |
| 400 | 997 | Device plan/program mandatory |
| 400 | APP076 | Existing device number interchange is different with requested device interchange |
| 400 | 994 | Invalid Encryption-Algorithm header value |
| 400 | 994 | Invalid Encryption Request Parameters |
| 400 | 994 | Cryptography error |