Skip to main content

Application

CardApplication

This API can be used to create virtual and physical payment cards.

Note: By default, newly created cards are inactive and must be explicitly activated via CardActivation action. Virtual cards can be used instantly after they are created and activated, while physical cards will need to be printed and sent by mail.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card NumbercardNumber Card NumberStringMaximum 19 charactersOptional
2Card FlagcardFlag V- Virtual/Nonphysical P- PhysicalStringMaximum 1 characterRequired
3Card Product CodecardProdCode Card Product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit CardStringMiximum 4 charactersRequiredDefined in Back Office
4Card Picture CodecardPicCode Card Picture CodeStringMaximum 15 charactersOptional
5Card Emboss NamecardEmbossName Card Emboss NameStringMaximum 26 charactersOptionalIf cardFlag = P and it is real-name card, the field is required.
6CIF NumbercustomerId Customer unique IDStringMaximum 32 charactersRequiredCustomer CIF number
7Customer ID TypecustIdType Customer NRIC Type:
D: Driver license
P: Default Id Type
I: National Professional ID card
U: Unified Multipurpose ID (UMID)
Z: Postal ID
V: Voter’s (COMELEC) ID Card
S: Social Security System (SSS)
T: Tax Identification Number (TIN)
O: Others
StringMaximum 1 charactersRequired 
8Customer ID NumbercustIdNo Customer NRIC No.StringMaximum 32 charactersRequiredA unique identifier for the customer
9Customer Issuer ID TypecustIssIdType Customer Issuer ID TypeStringMaximum 1 charactersOptional
10Customer Issuer ID No.custIssIdNo Customer Issuer ID No.StringMaximum 32 charactersOptionalCustomer's real document information, after KYC (if required)
11Customer NamecustName Customer NameStringMaximum 120 charactersOptional
12Customer Enligsh NamecustEngName Customer English NameStringMaximum 140 charactersOptional
13Customer ClasscustClass Customer ClassStringMaximum 4 charactersOptionalDefined in back office
14Customer Mobile NumbercustMobile Customer mobile numberStringMaximum 25 charactersOptional
15Customer E-mailcustEmail Customer E-mailStringMaximum 60 charactersOptional
16Customer SexcustSex Customer SexStringMaximum 1 charactersOptional
17Customer BirthdaycustBirthday Customer BirthdayStringMaximum 8 charactersOptional
18CountryhomeCountry CountryStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
19State/ProvincehomeState State/ProvinceStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
20CityhomeCity CityStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
21DistricthomeDistrict DistrictStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
22Street NamehomeStreetName Street NameStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
23Building NamehomeBuildingNameBuilding NameStringMaximum 6 charactersOptional
24House NumberhomeHouseNo House NumberStringMaximum 6 charactersOptional
25Postal CodehomePostalCode Zip CodeStringMaximum 6 charactersConditionalIf cardFlag = P, the field is required.
26CarriercarrierCarrierStringMaximum 10 charactersConditionalThales requested the following informationFixed Value: REGULAR
27PackagingpackagingPackagingStringMaximum 10 charactersConditionalPackaging Option. If no inserts , please use “NOINS”
28DispatchdispatchDispatchIf Bulk Id exists, then “IES_BULK” means batch dispatch.There can only be one delivery address for a batch dispatch, please fill in the above address information correctlyStringMaximum 10 charactersConditionalFor example:IESIES_BULK
29Recipient NamerecipientRecipientStringMaximum 60 charactersConditional
30Contact NumbercontactNoContact information of RecipientStringMaximum 20 charactersConditional
31Bulk IdbulkIdBulk IdBatch number starting from 01 for each calendar dayStringMaximum 10 charactersConditionalFor example: 01,02,03,04One batch cannot exceed 2000 cards
32SLASLASLAStringMaximum 10 charactersConditionalSLA with card manufactory Values :D02
33Logo Front IDlogoFrontIDLogo Front IDStringMaximum 32 charactersConditionalIf co-brand logos need to be printed on the card face
34Bulk Recipient NamebulkRecipientRecipient NameStringMaximum 60 charactersConditional
35Bulk Contact NumberbulkContactNoContact information of Recipient NameStringMaximum 20 charactersConditional
36CountrybulkCountryCountryStringMaximum 20 charactersOptionalISO-3166 (A3 better)If cardFlag = P, the field is required.
37State/ProvincebulkStateState/ProvinceStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
38CitybulkCityCityStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
39Address line 1bulkAddr1Address Line 1StringMaximum 40 charactersConditionalIf cardFlag = P, the field is required.
40Address line 2bulkAddr2Address Line 2StringMaximum 40 charactersOptional
41Address line 3bulkAddr3Address Line 3StringMaximum 40 charactersOptional
42Address line 4bulkAddr4Address Line 4StringMaximum 40 charactersOptional
43Postal CodebulkPostalCodeZip CodeStringMaximum 9 charactersConditionalIf cardFlag = P, the field is required.
44Billing Address CountrybillCountryCountry ISO-3166 (A3 better)StringMaximum 20 charactersConditional
45Billing Address State/ProvincebillStateState/ProvinceStringMaximum 20 charactersConditional
46Billing Address CitybillCityCityStringMaximum 20 charactersConditional
47Billing Address line 1billAddr1Address Line 1StringMaximum 40 charactersConditionalIf using AVS service , billing address is required
48Billing Address line 2billAddr2Address Line 2StringMaximum 40 charactersOptional
49Billing Address line 3billAddr3Address Line 3StringMaximum 40 charactersOptional
50Billing Address line 4billAddr4Address Line 4StringMaximum 40 charactersOptional
51Billing Postal CodebillPostalCodeZip CodeStringMaximum 9 charactersConditionalIf using AVS service , billing address is required
52Card Expiry DateexpiryDateCard Expiry DateStringYYMMOptional
53Card Emboss Name line 2cardEmbossName2Card Emboss Name line 2StringMaximum 26 charactersOptionalFor emboss company name on card (physical card)
54First NamecustFstNameCustomer’s First NameStringMaximum 35 charactersOptional
55Middle NamecustMidNameCustomer’s Middle NameStringMaximum 35 charactersOptional
56Last NamecustLstNameCustomer’s Last NameStringMaximum 35 charactersConditionalIf provide ANI, Last name is required

Response:

Response HeaderField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersRequired
2Card NumbercardNumberCard NumberStringMaximum 19 charactersRequired
3Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersRequired
4Card Expiry DateexpiryDateCard Expiry DateStringYYMMRequired
5CVV2CVV2CVV2StringMaximum 3 charactersRequired

CorporateCardApplication

This API can be used to create virtual and physical payment cards of a corporate account.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card NumbercardNumber Card NumberStringMaximum 19 charactersOptional
2Corporate IdcorporateId Corporate account idStringMaximum 15 charactersRequired
3Corporate Emboss NamecorpEmbossName Corporate Emboss NameStringMaximum 26 charactersoptionalIf is not use the default corporate emboss name
4Corporate image codecorpPicCode Corporate image codeStringMaximum 15 charactersoptional
5Card FlagcardFlag V- Virtual/Nonphysical P- PhysicalStringMaximum 1 characterRequired
6Card Product CodecardProdCode Card Product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit CardStringMiximum 4 charactersRequiredDefined in Back Office
7Card Picture CodecardPicCode Card Picture CodeStringMaximum 15 charactersOptional
8Card Emboss NamecardEmbossName Card Emboss NameStringMaximum 26 charactersOptionalIf cardFlag = P and it is real-name card, the field is required.
9CIF NumbercustomerId Customer unique IDStringMaximum 32 charactersRequiredCustomer CIF number
10Customer ID TypecustIdType Customer NRIC Type:
D: Driver license
P: Default Id Type
I: National Professional ID card
U: Unified Multipurpose ID (UMID)
Z: Postal ID
V: Voter’s (COMELEC) ID Card
S: Social Security System (SSS)
T: Tax Identification Number (TIN)
O: Others
StringMaximum 1 charactersRequired 
11Customer ID NumbercustIdNo Customer NRIC No.StringMaximum 32 charactersRequiredA unique identifier for the customer
12Customer Issuer ID TypecustIssIdType Customer Issuer ID TypeStringMaximum 1 charactersOptional
13Customer Issuer ID No.custIssIdNo Customer Issuer ID No.StringMaximum 32 charactersOptionalCustomer's real document information, after KYC (if required)
14Customer NamecustName Customer NameStringMaximum 120 charactersOptional
15Customer Enligsh NamecustEngName Customer English NameStringMaximum 140 charactersOptional
16Customer ClasscustClass Customer ClassStringMaximum 4 charactersOptionalDefined in back office
17Customer Mobile NumbercustMobile Customer mobile numberStringMaximum 25 charactersOptional
18Customer E-mailcustEmail Customer E-mailStringMaximum 60 charactersOptional
19Customer SexcustSex Customer SexStringMaximum 1 charactersOptional
20Customer BirthdaycustBirthday Customer BirthdayStringMaximum 8 charactersOptional
21Batch Application NobatchAppNo Batch Application Number for corporateStringMaximum 14 charactersOptional
22Delivery IndicatorcardMailInd Mail Address IndicatorStringMaximum 1 characterP=pickup C=Corporate H=Home Address
23Corporate CountrycorpCountry CountryStringMaximum 20 charactersOptionalIf cardFlag = P, the field is required.
24Corporate State/ProvincecorpState State/ProvinceStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
25Corporate CitycorpCity CityStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
26Corporate Address line 1corpAddr1 Corporate Address Line 1StringMaximum 40 charactersConditionalIf cardFlag = P, the field is required.
27Corporate Address line 2corpAddr2 Corporate Address Line 2StringMaximum 40 charactersOptional
28Corporate Address line 3corpAddr3 Corporate Address Line 3StringMaximum 40 charactersOptional
29Corporate Address line 4corpAddr4 Corporate Address Line 4StringMaximum 40 charactersOptional
30Corporate Postal CodecorpPostalCode Zip CodeStringMaximum 9 charactersConditionalIf cardFlag = P, the field is required.
31CountryhomeCountry CountryStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
32State/ProvincehomeState State/ProvinceStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
33CityhomeCity CityStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
34DistricthomeDistrict DistrictStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
35Street NamehomeStreetName Street NameStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
36Building NamehomeBuildingNameBuilding NameStringMaximum 6 charactersOptional
37House NumberhomeHouseNo House NumberStringMaximum 6 charactersOptional
38Postal CodehomePostalCode Zip CodeStringMaximum 6 charactersConditionalIf cardFlag = P, the field is required.
39CarriercarrierCarrierStringMaximum 10 charactersConditionalThales requested the following informationFixed Value: REGULAR
40PackagingpackagingPackagingStringMaximum 10 charactersConditionalPackaging Option. If no inserts , please use “NOINS”
41DispatchdispatchDispatchIf Bulk Id exists, then “IES_BULK” means batch dispatch.There can only be one delivery address for a batch dispatch, please fill in the above address information correctlyStringMaximum 10 charactersConditionalFor example:IESIES_BULK
42Bulk IdbulkIdBulk IdBatch number starting from 01 for each calendar dayStringMaximum 10 charactersConditionalFor example: 01,02,03,04One batch cannot exceed 2000 cards
43SLASLASLAStringMaximum 10 charactersConditionalSLA with card manufactory Values :D02
44Logo Front IDlogoFrontIDLogo Front IDStringMaximum 32 charactersConditionalIf co-brand logos need to be printed on the card face
45Bulk Recipient NamebulkRecipientRecipient NameStringMaximum 60 charactersConditional
46Bulk Contact NumberbulkContactNoContact information of Recipient NameStringMaximum 20 charactersConditional
47CountrybulkCountryCountryStringMaximum 20 charactersOptionalISO-3166 (A3 better)If cardFlag = P, the field is required.
48State/ProvincebulkStateState/ProvinceStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
49CitybulkCityCityStringMaximum 20 charactersConditionalIf cardFlag = P, the field is required.
50Address line 1bulkAddr1Address Line 1StringMaximum 40 charactersConditionalIf cardFlag = P, the field is required.
51Address line 2bulkAddr2Address Line 2StringMaximum 40 charactersOptional
52Address line 3bulkAddr3Address Line 3StringMaximum 40 charactersOptional
53Address line 4bulkAddr4Address Line 4StringMaximum 40 charactersOptional
54Postal CodebulkPostalCodeZip CodeStringMaximum 9 charactersConditionalIf cardFlag = P, the field is required.
55Billing Address CountrybillCountryCountry ISO-3166 (A3 better)StringMaximum 20 charactersConditional
56Billing Address State/ProvincebillStateState/ProvinceStringMaximum 20 charactersConditional
57Billing Address CitybillCityCityStringMaximum 20 charactersConditional
58Billing Address line 1billAddr1Address Line 1StringMaximum 40 charactersConditionalIf using AVS service , billing address is required
59Billing Address line 2billAddr2Address Line 2StringMaximum 40 charactersOptional
60Billing Address line 3billAddr3Address Line 3StringMaximum 40 charactersOptional
61Billing Address line 4billAddr4Address Line 4StringMaximum 40 charactersOptional
62Billing Postal CodebillPostalCodeZip CodeStringMaximum 9 charactersConditionalIf using AVS service , billing address is required
63Card Expiry DateexpiryDateCard Expiry DateStringYYMMOptional
64Card Emboss Name line 2cardEmbossName2Card Emboss Name line 2StringMaximum 26 charactersOptionalFor emboss company name on card (physical card)

Response:

Response HeaderField NameDescriptionFormatLengthM/ORemark
1Card Application NumbercardApplyNoCard Application NumberStringMaximum 16 charactersRequired
2CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersRequired
3Corporate IdcorporateIdCorporate account idStringMaximum 15 charactersRequiredCorporate Id
4Card NumbercardNumberCard NumberStringMaximum 19 charactersOptional
5Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersRequired
6Card Expiry DateexpiryDateCard Expiry DateStringYYMMRequired

CardApplyUpdate

This API is used to modify the delivery address before sending the card personalization data (including delivery information) to the card manufacturer.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Application NumbercardApplyNoCard Application NumberStringMaximum 16 charactersRequired
2CountryhomeCountryCountry ISO-3166 (A3 better)StringMaximum 20 charactersOptional
3State/ProvincehomeStateState/ProvinceStringMaximum 20 charactersOptional
4CityhomeCityCityStringMaximum 20 charactersOptional
5Address line 1homeAddr1Address Line 1StringMaximum 40 charactersOptional
6Address line 2homeAddr2Address Line 2StringMaximum 40 charactersOptional
7Address line 3homeAddr3Address Line 3StringMaximum 40 charactersOptional
8Address line 4homeAddr4Address Line 4StringMaximum 40 charactersOptional
9Postal CodehomePostalCodeZip CodeStringMaximum 9 charactersOptional
10Recipient NamerecipientRecipientStringMaximum 60 charactersConditional
11Contact NumbercontactNoContact information of RecipientStringMaximum 20 charactersConditional
12Bulk Recipient NamebulkRecipientRecipient NameStringMaximum 60 charactersConditional
13Bulk Contact NumberbulkContactNoContact information of Recipient NameStringMaximum 20 charactersConditional
14Billing Address CountrybillCountryCountry ISO-3166 (A3 better)StringMaximum 20 charactersConditional
15Billing Address State/ProvincebillStateState/ProvinceStringMaximum 20 charactersConditional
16Billing Address CitybillCityCityStringMaximum 20 charactersConditional
17Billing Address line 1billAddr1Address Line 1StringMaximum 40 charactersConditionalIf using AVS service , billing address is required
18Billing Address line 2billAddr2Address Line 2StringMaximum 40 charactersOptional
19Billing Address line 3billAddr3Address Line 3StringMaximum 40 charactersOptional
20Billing Address line 4billAddr4Address Line 4StringMaximum 40 charactersOptional
21Billing Postal CodebillPostalCodeZip CodeStringMaximum 9 charactersConditionalIf using AVS service , billing address is required

Response: None. Only response public header, please refer to the response code in header.