API Reference

Prepaid Customer Boarding

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

  1. If the system locates a device with status code as Normal (0), then that device is used for processing the request.
  2. If the CNA is linked to multiple devices with status code as Normal (0), the request is rejected.
  3. 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.
  4. 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

  1. If the system locates a device with status code as Normal (0), then that device is used for processing the request.
  2. If the CNA is linked to multiple devices with status code as Normal (0), the request is rejected.
  3. If the system does not find any device with status code as Normal (0), the system tries to search the CNA at institutional level.
  4. 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.
  5. 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.
  6. 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 CodeError CodeReason
403900User Or Bank does not support API
400997All 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:
500999Exception occurred while serving the request
500999Error while processing request: java.lang.IllegalArgumentException: Unrecognized field
500999Internal error
400997Branch Code field is mandatory
400997Maker Checker Flag field is invalid
400997Onboarding is not allowed on Device Plan: [Device plan code related to the device]
400APP053Error while processing the request
400APPUP00100Wallet Promotion Plan is Expired
400APPUP00101Device Plan Code is Mandatory
400APPUP00102Device Plan does not Exist
400APPUP00103Device Promotion Plan does not exist
400APPUP00104Device Photo Indicator does not exists
400APPUP00105Branch code does Not Exist
400APPUP00106Corporate Client is mandatory in case of Corporate Program code
400APPUP00107Corporate program is mandatory in case of Corporate client code
400APPUP00108Title Is Mandatory
400APPUP00109Last Name is Mandatory
400APPUP00110Gender is Mandatory
400APPUP00111Value for Marital Status is Mandatory
400APPUP00112Nationality is Mandatory
400APPUP00113APPLICATION_TYPE CODE Is Not Exist In system codes
400APPUP00114Birth Date is mandatory
400APPUP00115Birth date should be less than institution date
400APPUP00116Invalid Birth date format
400APPUP00117Invalid birth country
400APPUP00118Preferred mailing address is mandatory
400APPUP00119Preferred mailing address should have one of the following values - C: Current, P: Permanent, O: Office
400APPUP00120CURRENT_ADDRESS_LINE1 is mandatory
400APPUP00121Current Country /State /City /Zip Code is mandatory
400APPUP00122Current Country /State /City /Zip Code is Invalid
400APPUP00123PERMANENT_ADDRESS_LINE1 is mandatory
400APPUP00124Permanent Country /State /City /Zip Code is mandatory
400APPUP00125Permanent Current Country /State /City /Zip Code is Invalid
400APPUP00126Office Address is mandatory
400APPUP00127Office Country /State /City /Zip Code is mandatory
400APPUP00128Office Current Country /State /City /Zip Code is Invalid
400APPUP00129Occupation must be present in the system
400APPUP00130Register for DNCR flag should be Y or N
400APPUP00131SMS alert list should be Y or N
400APPUP00132EMAIL alert list should be Y or N
400APPUP00133Value for Statement Preference should be E Email/H Hard Copy/B - Both
400APPUP00134Kyc Required Falg on Program should be Y or N
400APPUP00135Number of Documents sent in application record is less than Doc. required on program
400APPUP00136Embossing name is mandatory
400APPUP00137VIP Flag value is invalid
400APPUP00138Legal Document is mandatory if Legal Type is mandatory or vice versa
400APPUP00139Legal Id type is invalid
400APPUP00140SOME Legal Id is Matched with another Legal Id
400APPUP00141Legal Id Type is Matched with another Legal Id Type
400APPUP00142Device is not in Normal State
400APPUP00143Device Range is either Inactive or Exhausted
400APPUP00144Wallet is not in Normal State
400APPUP00145First Name is Mandatory
400APPUP00146Value for Education must be 0,1,2,3,4,5,6,7,10
400APPUP00147Value for Delivery mode must be 0,1,2
400APPUP00148Value for Language Preference must be FR, DE, PL, PT, ES, EN
400APPUP00149Value for legal identification type must be 01,02,03,04,05,06,07,08,09,10
400APPUP00150Value for Employment Status must be 0,1,2,3,4,5,6,7
400APPUP00151Value for Comp Type must be 0,1,2,3
400APPUP00152Value for Applicant Prof must be 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15
400APPUP00153Value for Residence Status must be 0,1,2,3,4,5,6,7
400APPUP00154Value for Owned Vehicle Type must be 0,1,2
400APPUP00155Value for Empl Designation must be 0,1,2,3,4,5,6,7,8,9
400APPUP00156Value for Other Account Type must be C,D,S
400APPUP00157Value for Customer Type is Mandatory
400APPUP00158Mandatory Legal Id Type is missing in file, Check Documnet Checklist plan
400APPUP00159Client can have only one primary device under same program
400APPUP00162Value for Legal ID 1 Issuance place is Mandatory
400APPUP00163Value for Legal ID 2 Issuance place is Mandatory
400APPUP00164Value for Legal ID 3 Issuance place is Mandatory
400APPUP00165Value for Legal ID 4 Issuance place is Mandatory
400APPUP00166Value for Legal id 1 expiry date is Mandatory
400APPUP00167Value for Legal id 2 expiry date is Mandatory
400APPUP00168Value for Legal id 3 expiry date is Mandatory
400APPUP00169Value for Legal id 4 expiry date is Mandatory
400APPUP00170Invalid Device type/Program
400APPUP00171For LVC Device type Registered mail Id must be mandatory
400APPUP00172Value for legal id must not match with other legal id in same application
400APPUP00173Invalid Device type in file
400APPUP00174Invalid application type / Sub type
400APPUP00175Supplementary device is allowed only for existing client
400APPUP00176Birthdate validation failed
400APPUP00177Invalid value for Current Zip Code
400APPUP00178Current Zip Code is mandatory
400APPUP00179Invalid value for Current City Code
400APPUP00180Invalid value for Current State Code
400APPUP00181Permanent Country Code is mandatory
400APPUP00183Permanent Zip Code is mandatory
400APPUP00184Invalid value for Permanent City Code
400APPUP00185Child1 Birth date should be less than institution date
400APPUP00186Child2 Birth date should be less than institution date
400APPUP00188Invalid value for Office Zip Code
400APPUP00189Office Zip Code is mandatory
400APPUP00190Invalid value for Office City Code
400APPUP00191Risk category value is invalid, possible values are A/B/C/D/E/F
400APPUP00192Invalid value for application status, possible values are V,F
400APPUP00193Add-on mobile number/ISD code is mandatory
400APPUP00194Email Id is invalid
400APPUP00195Length of Client Customer ID is invalid
400APPUP00196Client Customer ID not matched with existing Client
400APPUP00197Direct_Debit_Account_Name is mandatory
400APPUP00198Direct_Debit_Account_Number is mandatory
400APPUP00199Direct_Debit_Account_Type is mandatory
400APPUP00200Direct_Debit_Branch is mandatory
400APPUP00201Direct_Debit_Percentage is mandatory
400APPUP00202Direct Debit Percentage should be positive /less than equal to 100
400APPUP00203Reference mobile number/ISD code is mandatory
400APPUP00204Reference ISD code is invalid
400APPUP00205Office mobile number/ISD code is mandatory
400APPUP00206Office ISD code is invalid
400APPUP00207Registered mobile number/ISD code is mandatory
400APPUP00208Registered ISD code is invalid
400APPUP00209Addon ISD code is invalid
400APPUP00211Existing Device Number is mandatory
400APPUP00212Existing Client Code is mandatory
400APPUP00213Existing Device Number / Primary Application number is mandatory
400APPUP00214Existing Addon Client Code is mandatory
400APPUP00215Device is already created against this application, enter only existing device number to continue
400APPUP00216Invalid value for Current Country Code
400APPUP00217Invalid value for Permanent Country Code
400APPUP00218Invalid value for Office Country Code
400APPUP00219Photo Code is Mandatory
400APPUP00220Invalid value for Nationality (Country Code)
400APPUP00221Invalid Marital Status, Not Exist in SYSTEM_CODES
400APPUP00223If value for Email Alert List is Y then Registered mail Id is mandatory
400APPUP00227Value for Program Code is mandatory
400APPUP00228Value for Branch code is mandatory
400APPUP00229Value for Application Type is mandatory
400APPUP00230Value for Application Sub Type is mandatory
400APPUP00231Value for Product Type is mandatory
400APPUP00232Device type 1 is mandatory
400APPUP00233Device Photo Indicator1 is mandatory
400APPUP00234Invalid device photo indicator for selected device type
400APPUP00237Invalid billing cycle code
400APPUP00242Picture Code is required for this combination Program Code and Photo Indicator [2]
400APPUP00244Language preference is Mandatory
400APPUP00251Invalid Event based fee code
400APPUP00252Invalid Maintenance based fee code
400APPUP00253Invalid wallet fee plan code
400APPUP00254Multiple Primary/Addon for same Program ID are not allowed
400APPUP00255Existing client code not present
400APPUP00256Existing client code is add on client
400APPUP00257Permanent Promo plan code not exist in system
400APPUP00258Add on relation is mandatory
400APPUP00259Invalid direct debit flag
400APPUP00260Add on Embossed name is mandatory
400APPUP00261Invalid Direct debit amount flag/Account type is not present
400APPUP00262Invalid Direct debit amount flag
400APPUP00263Invalid Add on relation
400APPUP00264Program Code does not exist
400APPUP00268Office Email Id is invalid
400APPUP00269Invalid Addon Gender
400APPUP00270Nominee Email Id is invalid
400APPUP00271Addon Email Id is invalid
400APPUP00274Device plan code is invalid
400APPUP00275Invalid Existing Device Number
400APP001Caught in Dedupe. /SDN matching
400APP00161Corporate client code should be blank for non corporate application
400APP00162Customer type should not be corporate for Addon application
400APP00163Corporate issuance is not allowed to Add-on
400APP002Error while processing Dedupe. /SDN matching
400APP003Existing Addon Client Code is mandatory
400APP004Existing Client Code is Invalid / Not in normal status
400APP005Invalid Corporate Client Code
400APP006Either Existing Device Number or Primary application Number is mandatory
400APP007Existing Device Number is Invalid /Not in Normal Status/ Expired
400APP008Error While Processing Application
400APP011Instant card not supported for this institution
400APP012Card PACK ID Range is exhausted. /Card Range exhausted
400APP013Error in sequence number generation
400APP014Card generation failed as IPK certificate expired
400APP015Error card number generation, Maximum 9 Add-on devices are permitted in base device
400APP016Device range not defined for the selected Branch, Program, Device Plan, and Network./Sequence number ,max and min range must be present
400APP017CARD PACK ID GENERATED WITH INVALID CARD NUMBER LENGTH. /Device generated with invalid length
400APP019Please check Device Range. Issuer Bin is null for device RANGE
400APP020Client is ALREADY having any primary/secondary device of applied product
400APP021Client should not have any device of selected program
400APP022Device generated is Stop listed. /Error card pack id generation, Check Card Pack id generation template
400APP023Device Type and Device Plan - Combination should be unique always
400APP024Mobile number is mandatory if device type is selected as Mobile
400APP025Existing Client Code is InActive / Not registered
400APP027Mobile device type allowed only once per application, request declined
400APP028Entered Mobile number is already used. Please user other mobile number
400APP029Invalid Picture Code
400APP030Error While Validating Business Mandatory fields Incomplete Application
400APP031Error while processing Application (Technical Reason, Check Configuration)
400APP032For Generating Card Pack ID Program code or Free Text must be present in template
400APP033Error in Card Pack Id generation. Please check logs
400APP034Invalid Primary Application Number
400APP035Error card number generation, Please check device id generation template
400APP036Error in Device generation. Please check logs
400APP043Supplementary Card Issuance Allowed for Primary Clients Only
400APP100Duplicate application Id
400APP126Existing client is already KYC compliant/Check KYC status of Program
400APPCRLMT02Cash Limit is less than the Limit defined at the Branch
400APPCRLMT03Cash Limit is more than the Limit defined at the Branch
400APPCRLMT04Credit Limit is less than the Limit defined at the Branch
400APPCRLMT05Credit Limit is more than the Limit defined at the Branch
400APPCRLMT06Cash Limit should be less than maximum credit limit at the branch
400APPCRLMT07Cash Limit should be less than credit limit
400APPCRLMT08Credit limit is less than the limit defined at the program
400APPCRLMT09Credit limit is more than the limit defined at the program
400APPCRLMT10Credit limit is mandatory if cash limit is given
400APPCRLMT11Cash limit must be equal to program fixed cash limit
400APPCRLMT12Cash limit must be greater than product minimum cash limit
400APPCRLMT13Cash limit must be less than product maximum cash limit
400CRDUPL001Invalid Device Identifier
400CRDUPL002Invalid Device Identifier
400CRDUPL003Account number and account type is Mandatory for Primary device request
400CRDUPL004Office E-mail ID not present
400CRDUPL005Device Picture indicator not available
400CRDUPL006Invalid Nationality
400CRDUPL007Primary device number is Mandatory for supplementary and add on device
400CRDUPL008Invalid Account type
400CRDUPL009Invalid Device Identifier type
400CRDUPL010Branch Code is mandatory for primary device
400CRDUPL011For Pre-generated device Delivery Flag should be one
400CRDUPL013Corporate client code is mandatory
400CRDUPL014Account already linked to different client
400CRDUPL015For Individual/Bank staff customer program should not be corporate program
400CRDUPL016Customer Type should be in 0,1 or 2
400CRDUPL017Program should be Corporate program
400CRDUPL018Invalid corporate client code
400CRDUPL019Permanent E-mail ID not present
400CRDUPL020Device Photo indicator not available
400CRDUPL021Delivery Date is not present
400CRDUPL022Error in selection SDN_PLAN
400CRDUPL023Error in selection SDN_PLAN
400CRDUPL024Error while processing request
400CRDUPL031Error in institution selection
400CRDUPL032Error in institution selection
400CRDUPL033Account number length not as per length defined at Institution level
400CRDUPL034Error in institution selection
400CRDUPL035Error in institution selection
400CRDUPL036Client number length not as per length defined at Institution level
400162Program Code already Exist for respective Client
400BTHUP00111Client Code is not present
400PROMPU0104Promo Plan Not Exits
400HDE602Client of this device is not registered
400FDDP0001First Name of New Client cannot be blank
400FDDP0002CURRENT ADDRESS of New Client cannot be blank
400FDDP0038Device details are invalid. Error when existing client and device details are incorrect
400FDDP0039Client Code is not valid. Error when existing client and client details are incorrect
400FDDP0040Add-on Client code cannot be blank. Error when existing client request type is add-on and existing add-on client code is null
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. Error when embossed name is not null, length less than 2, alphanumeric and special characters as [space] and [dot] for add-on cards
400ISE40000Mandatory field validation failed
400997Per Transaction Limit field should be numeric
400997Per Transaction Limit field value must have maxlength 20
400997Velocity field value must have maxlength 6
400997Velocity field should be numeric
400997Total transaction Limit field should be numeric
400997Total transaction Limit field value must have maxlength 20
400997Expiry 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
400997Per Transaction Limit is not allowed for Device Type other than type 8
400997Velocity is not allowed for Device Type other than type 8
400997Total Transaction Limit is not allowed for Device Type other than type 8
400997Expiry Date is not allowed for Device Type other than type 8
400997clientCustomerID field value must have max length 20
400997clientCustomerID field should be alphanumeric
400997Application Type field is invalid
400997Existing Card Number Alias field is not allowed with Existing Device Number or for New Primary application type
400997Existing Add-On Card Number Alias field is not allowed with Existing Add-On Client Code or allowed for Existing Add-On application type only
400997Either Existing Device Number or Existing Card Number Alias field is mandatory
400997Either Existing Add-on Client Code or Existing Add-On Card Number Alias field is mandatory
400997Existing Card Number Alias field should be alphanumeric
400997Existing Card Number Alias field value must have max length 24
400997Existing Add on Card Number Alias field should be alphanumeric
400997Existing Add On Card Number Alias field value must have max length 24
400997Existing Program Code field should be alphanumeric. Underscore are allowed and must start and end with an alphanumeric character
400997Existing Device Plan Code field should be alphanumeric. Underscores are allowed and must start and end with an alphanumeric character
400997Existing AddOn Program Code field should be alphanumeric. Underscore are allowed and must start and end with an alphanumeric character
400997Existing AddOn Device Plan Code field should be alphanumeric. Underscores are allowed and must start and end with an alphanumeric character
400997Existing Program Code field value must have max length 10
400997Existing Device Plan Code field value must have max length 10
400997Existing AddOn Program Code field value must have max length 10
400997Existing AddOn Device Plan Code field value must have max length 10
400APP050Supplementary Card Issuance Allowed For Primary Clients Only
400APP051Wallet is in Freeze or closed status
400APP052Existing Device Number is not in Valid status
400APP055Existing CNA applicable only for Prepaid product
400APPUP00309Either Existing Device number or Existing Card number Alias should be present
400APPUP00310Either Existing Add on Client code or Existing Add on Card number Alias should be present for application type 5
400CNA001Error While processing request
400CNA003No Data Found
400CNA005Too many Devices for CAN
400997Device plan/program mandatory
400APP076Existing device number interchange is different with requested device interchange
400994Invalid Encryption-Algorithm header value
400994Invalid Encryption Request Parameters
400994Cryptography error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Alphanumeric. Length: 10.

string
enum
required
length ≤ 1
^[PAS]$

Valid values: P (Primary Device), S (Supplementary), A (Add-on). Alphanumeric. Length: 1. If applicationType is A and applicationSubType is E, multiple add-on LVC devices can be issued to the same add-on client under the same program. If applicationType is S and applicationSubType is E, multiple supplementary LVC devices can be issued to the same primary client under the same program.

Allowed:
string
enum
required
length ≤ 1
^[NE]$

Valid values: N (New Program/Client), E (Existing Program/Client). Alphanumeric. Length: 1.

Allowed:
string
enum
required
length ≤ 1
^[0-2]$

Valid values: 0 (Individual), 1 (Corporate), 2 (Bank Staff). Value should be 1 for corporate program code. Alphanumeric. Length: 1.

Allowed:
string
required
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Not required for Supplementary Device or Add-on Device. Alphanumeric. Length: 10.

string
length ≤ 24
^[0-9]{0,24}$

Mandatory for all application types except Primary Device - New Client. The existingDeviceNumber should always be a primary device number when the application type is supplementary and product type is prepaid. If applicationType is S and applicationSubType is E: wallet attached to the card should not be in Freeze or Closed status; if multiple GPR wallets are attached, at least one wallet should be active; device must not have statuses: DEVICE TECHNOLOGY UPGRADE [24], NOT ACTIVATED CARD [11], CARD DISPATCHED [15], READY FOR SALE [16], TRANSFERRED TO OTHER BRANCH [17], RETURNED AND SHREDDED [18], REPLACED [4]. If applicationType is P and applicationSubType is E, device must not have the same statuses. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9]{0,24}$

Required for Primary Device – Existing Client, Supplementary – Existing Client, Add-on Client. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9]{0,24}$

Required for Add-on Device – Existing Client. Alphanumeric. Length: 24.

string
length ≤ 20
^(M|B|D|F|O|S|SO|SP|FIL|MIL|Business Card)?$

Required for Add-on Client. Valid values: 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. Mandatory for applicationType='A' and applicationSubType='N'. Alphanumeric. Length: 20.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Wallet Promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
enum
required
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Device plan code as configured in customer portal for that program. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Device promotion plan code as configured in customer portal. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
enum
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Should be part of the selected Program Code and present in Device Plan table. Mandatory if deviceType2 is selected. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

If specified, the value should be present in Device Promotion Plan table. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Required if deviceType2 is sent in request. Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
enum
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Should be part of the selected Program Code and present in Device Plan table. Mandatory if deviceType3 is selected. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

If specified, the value should be present in Device Promotion Plan table. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Required if deviceType3 is sent in request. Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
enum
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Should be part of the selected Program Code and present in Device Plan table. Mandatory if deviceType4 is selected. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

If specified, the value should be present in Device Promotion Plan table. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Required if deviceType4 is sent in request. Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
enum
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Should be part of the selected Program Code and present in Device Plan table. Mandatory if deviceType5 is selected. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

If specified, the value should be present in Device Promotion Plan table. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Required if deviceType5 is sent in request. Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
enum
length ≤ 2
^(1|2|3|4|5|6|7|8|16)?$

Valid values: 1 (Magnetic Stripe Card), 2 (EMV Card), 3 (Physical NFC Device - Mag Stripe PayPass), 4 (Physical NFC Device - EMV PayPass), 5 (Physical NFC Device - PayPass), 6 (Mobile), 7 (Static Virtual Card), 8 (Limited Validity Virtual Card), 16 (PayPak NFC Device - EMV Contactless). Alphanumeric. Length: 2.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Should be part of the selected Program Code and present in Device Plan table. Mandatory if deviceType6 is selected. Alphanumeric. Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

If specified, the value should be present in Device Promotion Plan table. Alphanumeric. Length: 10.

string
enum
length ≤ 1
^[0-2]?$

Required if deviceType6 is sent in request. Valid values: 0 (Normal), 1 (Photo), 2 (Picture). Alphanumeric. Length: 1.

Allowed:
string
length ≤ 6
^[a-zA-Z0-9]{0,6}$

Unique code of the branch. Should be configured at the institution. Mandatory for Primary Device New client. For Primary Device - Existing Client (New Program) and Supplementary Device - Existing Program, if sent, the branch code is changed for the client along with associated Primary, Supplementary, and Add-On cards. For Add On with new Client and Supplementary Existing Program for Corporate Device, the value should be empty or match the Primary client's branch code; if it does not match, the request is rejected. Alphanumeric. Length: 6.

string
length ≤ 24
^[a-zA-Z0-9]{0,24}$

Required for corporate device issuance. Alphanumeric. Length: 24.

string
enum
required
length ≤ 1
^[YN]$

Flag indicating whether instant card is to be generated when the request is successful. Valid values: Y (Yes), N (No). Character. Length: 1.

Allowed:
string
enum
length ≤ 1
^[YN]?$

Flag indicating whether the new prepaid card application should go through the checker approval process prior to customer onboarding. Valid values: Y (Yes, application is sent to checker's queue after Dedupe and SDN verification), N (No). If null or not sent, the application is processed as per the standard process. If instantCardFlag is Y, this field's value is ignored. Character. Length: 1.

Allowed:
string
enum
length ≤ 1
^[YN]?$

Valid values: Y (Numberless), N (Numbered), BLANK (considered as NULL). Character. Length: 1.

Allowed:
string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode1. Required if configured as ‘Business Mandatory’ on ‘Card Management > Program Setup > Application > Business Mandatory Fields’ screen. Allowed special characters: !'()*+,-.:;=?[]{}|. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode2. Same validations as cardNumberAlias1. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode3. Same validations as cardNumberAlias1. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode4. Same validations as cardNumberAlias1. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode5. Same validations as cardNumberAlias1. Alphanumeric. Length: 24.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card Number Alias corresponding to devicePlanCode6. Same validations as cardNumberAlias1. Alphanumeric. Length: 24.

string
length ≤ 7
^\d{2,3}\d{2}\d{2}$

Date and time until which the Limited Validity Card (LVC) is valid. Applicable only if devicePlanCode is of device type LVC. Date format: DDHHMI (Days, hours, minutes) or DDDHHMI if expiry days are more than 99. If LVC details are not received, details from the respective device plan in the customer portal are used. Limit can be overwritten if Allow Overriding LVC Limits is selected for the device plan. Length: 7.

integer
≤ 100000000000000000000

Transaction limit set for each transaction on the Limited Validity Card (LVC). Applicable only if devicePlanCode is of device type LVC. If LVC details are not received, details from the respective device plan in the customer portal are used. Limit can be overwritten if Allow Overriding LVC Limits is selected for the device plan. Numeric. Maximum length: 20.

integer
≤ 999999

Number of transactions allowed for the Limited Validity Card (LVC). Applicable only if devicePlanCode is of device type LVC. If LVC details are not received, details from the respective device plan in the customer portal are used. Limit can be overwritten if Allow Overriding LVC Limits is selected for the device plan. Numeric. Maximum length: 6.

integer
≤ 100000000000000000000

Maximum amount configured for the Limited Validity Card (LVC). Applicable only if devicePlanCode is of device type LVC. If LVC details are not received, details from the respective device plan in the customer portal are used. Limit can be overwritten if Allow Overriding LVC Limits is selected for the device plan. Numeric. Maximum length: 20.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card number alias of the existing card. Must be blank if existingDeviceNumber is received. Applicable to all application types except Primary Device - New Client. Same validations for device statuses as existingDeviceNumber. Alphanumeric. Maximum Length: 24.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Program code of the existing program. Required only when multiple devices are linked with the same existingCardNumberAlias. Alphanumeric. Maximum Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Device plan code of the existing device. Required only when multiple devices are linked with the same existingCardNumberAlias. Alphanumeric. Maximum Length: 10.

string
length ≤ 24
^[a-zA-Z0-9!'\(\)*+,-\._:;=\?\[\]_\{\}\|]{0,24}$

Card number alias of the existing add-on card. Must be blank if existingAddOnClientCode is received. Applicable if application type is Existing Client - Add on Device. Alphanumeric. Maximum Length: 24.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Program code of the existing add-on card. Required only when multiple devices are linked to the same existingAddOnCardNumberAlias. Alphanumeric. Maximum Length: 10.

string
length ≤ 10
^[a-zA-Z0-9]{0,10}$

Device plan of the existing add-on card. Required only when multiple devices are linked with the same existingAddOnCardNumberAlias. Alphanumeric. Maximum Length: 10.

string
length ≤ 20
^[a-zA-Z0-9]{0,20}$

Client Customer ID. Created and displayed on the application. Can be configured as a Business Mandatory Field. Alphanumeric. Length: 20.

profile
object

Profile information of the cardholder.

string
length ≤ 15
^[a-zA-Z0-9]{0,15}$

Unique code that identifies the background picture printed on the card. If not received, picture code from device plan is used. If neither is available, request is rejected. Mandatory if devicePhotoIndicator is 2 and picture code is not available at device plan level. Alphanumeric. Length: 15.

string
length ≤ 15
^[a-zA-Z0-9]{0,15}$

No validation on code. String. Length: 15.

string
enum
length ≤ 1
^[YN]?$

Client KYC status. Valid values: Y (KYC Compliant), N/Blank (KYC Pending). Alphanumeric. Length: 1.

Allowed:
string
length ≤ 100
^[\s\S]{0,100}$

Required if KYC Status is set to Y. String. Length: 100.

contactInfo
object

Contact information.

string
enum
length ≤ 1
^[0-2]?$

Should be present in SYSTEM_CODES table against TYPE_ID = ‘DELIVERY_MODE’. Valid values: 0 (Branch), 1 (Payment system department), 2 (Mail). Application request with instantCardFlag as ‘Y’ must have delivery mode 0 (Branch). Alphanumeric. Length: 1.

Allowed:
currentAddress
object

Current address details.

permanentAddress
object

Permanent address details.

officeAddress
object

Office address details.

occupation
object

Occupation details.

legalDocuments
object

Legal document details.

clientExtraFields
object

Additional client fields.

customFields
object

Custom fields for additional data.

string
required
length ≤ 14
^\d{14}$

Timestamp of the request. Format: YYYYMMDDHHMMSS. Mandatory. Length: 14.

additionalInfo
object

Additional information for the request.

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

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

Updated about 1 year ago

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

Updated about 1 year ago

Did this page help you?