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 Element | Field Name | Description | Format | Length | M/O | Remark | |
|---|---|---|---|---|---|---|---|
| 1 | Card Number | cardNumber | Card Number | String | Maximum 19 characters | Optional | |
| 2 | Card Flag | cardFlag | V- Virtual/Nonphysical P- Physical | String | Maximum 1 character | Required | |
| 3 | Card Product Code | cardProdCode | Card Product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit Card | String | Miximum 4 characters | Required | Defined in Back Office |
| 4 | Card Picture Code | cardPicCode | Card Picture Code | String | Maximum 15 characters | Optional | |
| 5 | Card Emboss Name | cardEmbossName | Card Emboss Name | String | Maximum 26 characters | Optional | If cardFlag = P and it is real-name card, the field is required. |
| 6 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Required | Customer CIF number |
| 7 | Customer ID Type | custIdType | 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 | String | Maximum 1 characters | Required | |
| 8 | Customer ID Number | custIdNo | Customer NRIC No. | String | Maximum 32 characters | Required | A unique identifier for the customer |
| 9 | Customer Issuer ID Type | custIssIdType | Customer Issuer ID Type | String | Maximum 1 characters | Optional | |
| 10 | Customer Issuer ID No. | custIssIdNo | Customer Issuer ID No. | String | Maximum 32 characters | Optional | Customer's real document information, after KYC (if required) |
| 11 | Customer Name | custName | Customer Name | String | Maximum 120 characters | Optional | |
| 12 | Customer Enligsh Name | custEngName | Customer English Name | String | Maximum 140 characters | Optional | |
| 13 | Customer Class | custClass | Customer Class | String | Maximum 4 characters | Optional | Defined in back office |
| 14 | Customer Mobile Number | custMobile | Customer mobile number | String | Maximum 25 characters | Optional | |
| 15 | Customer E-mail | custEmail | Customer E-mail | String | Maximum 60 characters | Optional | |
| 16 | Customer Sex | custSex | Customer Sex | String | Maximum 1 characters | Optional | |
| 17 | Customer Birthday | custBirthday | Customer Birthday | String | Maximum 8 characters | Optional | |
| 18 | Country | homeCountry | Country | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 19 | State/Province | homeState | State/Province | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 20 | City | homeCity | City | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 21 | District | homeDistrict | District | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 22 | Street Name | homeStreetName | Street Name | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 23 | Building Name | homeBuildingName | Building Name | String | Maximum 6 characters | Optional | |
| 24 | House Number | homeHouseNo | House Number | String | Maximum 6 characters | Optional | |
| 25 | Postal Code | homePostalCode | Zip Code | String | Maximum 6 characters | Conditional | If cardFlag = P, the field is required. |
| 26 | Carrier | carrier | Carrier | String | Maximum 10 characters | Conditional | Thales requested the following informationFixed Value: REGULAR |
| 27 | Packaging | packaging | Packaging | String | Maximum 10 characters | Conditional | Packaging Option. If no inserts , please use “NOINS” |
| 28 | Dispatch | dispatch | DispatchIf 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 correctly | String | Maximum 10 characters | Conditional | For example:IESIES_BULK |
| 29 | Recipient Name | recipient | Recipient | String | Maximum 60 characters | Conditional | |
| 30 | Contact Number | contactNo | Contact information of Recipient | String | Maximum 20 characters | Conditional | |
| 31 | Bulk Id | bulkId | Bulk IdBatch number starting from 01 for each calendar day | String | Maximum 10 characters | Conditional | For example: 01,02,03,04One batch cannot exceed 2000 cards |
| 32 | SLA | SLA | SLA | String | Maximum 10 characters | Conditional | SLA with card manufactory Values :D02 |
| 33 | Logo Front ID | logoFrontID | Logo Front ID | String | Maximum 32 characters | Conditional | If co-brand logos need to be printed on the card face |
| 34 | Bulk Recipient Name | bulkRecipient | Recipient Name | String | Maximum 60 characters | Conditional | |
| 35 | Bulk Contact Number | bulkContactNo | Contact information of Recipient Name | String | Maximum 20 characters | Conditional | |
| 36 | Country | bulkCountry | Country | String | Maximum 20 characters | Optional | ISO-3166 (A3 better)If cardFlag = P, the field is required. |
| 37 | State/Province | bulkState | State/Province | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 38 | City | bulkCity | City | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 39 | Address line 1 | bulkAddr1 | Address Line 1 | String | Maximum 40 characters | Conditional | If cardFlag = P, the field is required. |
| 40 | Address line 2 | bulkAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 41 | Address line 3 | bulkAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 42 | Address line 4 | bulkAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 43 | Postal Code | bulkPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If cardFlag = P, the field is required. |
| 44 | Billing Address Country | billCountry | Country ISO-3166 (A3 better) | String | Maximum 20 characters | Conditional | |
| 45 | Billing Address State/Province | billState | State/Province | String | Maximum 20 characters | Conditional | |
| 46 | Billing Address City | billCity | City | String | Maximum 20 characters | Conditional | |
| 47 | Billing Address line 1 | billAddr1 | Address Line 1 | String | Maximum 40 characters | Conditional | If using AVS service , billing address is required |
| 48 | Billing Address line 2 | billAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 49 | Billing Address line 3 | billAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 50 | Billing Address line 4 | billAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 51 | Billing Postal Code | billPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If using AVS service , billing address is required |
| 52 | Card Expiry Date | expiryDate | Card Expiry Date | String | YYMM | Optional | |
| 53 | Card Emboss Name line 2 | cardEmbossName2 | Card Emboss Name line 2 | String | Maximum 26 characters | Optional | For emboss company name on card (physical card) |
| 54 | First Name | custFstName | Customer’s First Name | String | Maximum 35 characters | Optional | |
| 55 | Middle Name | custMidName | Customer’s Middle Name | String | Maximum 35 characters | Optional | |
| 56 | Last Name | custLstName | Customer’s Last Name | String | Maximum 35 characters | Conditional | If provide ANI, Last name is required |
Response:
| Response Header | Field Name | Description | Format | Length | M/O | Remark | |
|---|---|---|---|---|---|---|---|
| 1 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Required | |
| 2 | Card Number | cardNumber | Card Number | String | Maximum 19 characters | Required | |
| 3 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Required | |
| 4 | Card Expiry Date | expiryDate | Card Expiry Date | String | YYMM | Required | |
| 5 | CVV2 | CVV2 | CVV2 | String | Maximum 3 characters | Required |
CorporateCardApplication
This API can be used to create virtual and physical payment cards of a corporate account.
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
|---|---|---|---|---|---|---|---|
| 1 | Card Number | cardNumber | Card Number | String | Maximum 19 characters | Optional | |
| 2 | Corporate Id | corporateId | Corporate account id | String | Maximum 15 characters | Required | |
| 3 | Corporate Emboss Name | corpEmbossName | Corporate Emboss Name | String | Maximum 26 characters | optional | If is not use the default corporate emboss name |
| 4 | Corporate image code | corpPicCode | Corporate image code | String | Maximum 15 characters | optional | |
| 5 | Card Flag | cardFlag | V- Virtual/Nonphysical P- Physical | String | Maximum 1 character | Required | |
| 6 | Card Product Code | cardProdCode | Card Product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit Card | String | Miximum 4 characters | Required | Defined in Back Office |
| 7 | Card Picture Code | cardPicCode | Card Picture Code | String | Maximum 15 characters | Optional | |
| 8 | Card Emboss Name | cardEmbossName | Card Emboss Name | String | Maximum 26 characters | Optional | If cardFlag = P and it is real-name card, the field is required. |
| 9 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Required | Customer CIF number |
| 10 | Customer ID Type | custIdType | 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 | String | Maximum 1 characters | Required | |
| 11 | Customer ID Number | custIdNo | Customer NRIC No. | String | Maximum 32 characters | Required | A unique identifier for the customer |
| 12 | Customer Issuer ID Type | custIssIdType | Customer Issuer ID Type | String | Maximum 1 characters | Optional | |
| 13 | Customer Issuer ID No. | custIssIdNo | Customer Issuer ID No. | String | Maximum 32 characters | Optional | Customer's real document information, after KYC (if required) |
| 14 | Customer Name | custName | Customer Name | String | Maximum 120 characters | Optional | |
| 15 | Customer Enligsh Name | custEngName | Customer English Name | String | Maximum 140 characters | Optional | |
| 16 | Customer Class | custClass | Customer Class | String | Maximum 4 characters | Optional | Defined in back office |
| 17 | Customer Mobile Number | custMobile | Customer mobile number | String | Maximum 25 characters | Optional | |
| 18 | Customer E-mail | custEmail | Customer E-mail | String | Maximum 60 characters | Optional | |
| 19 | Customer Sex | custSex | Customer Sex | String | Maximum 1 characters | Optional | |
| 20 | Customer Birthday | custBirthday | Customer Birthday | String | Maximum 8 characters | Optional | |
| 21 | Batch Application No | batchAppNo | Batch Application Number for corporate | String | Maximum 14 characters | Optional | |
| 22 | Delivery Indicator | cardMailInd | Mail Address Indicator | String | Maximum 1 character | P=pickup C=Corporate H=Home Address | |
| 23 | Corporate Country | corpCountry | Country | String | Maximum 20 characters | Optional | If cardFlag = P, the field is required. |
| 24 | Corporate State/Province | corpState | State/Province | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 25 | Corporate City | corpCity | City | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 26 | Corporate Address line 1 | corpAddr1 | Corporate Address Line 1 | String | Maximum 40 characters | Conditional | If cardFlag = P, the field is required. |
| 27 | Corporate Address line 2 | corpAddr2 | Corporate Address Line 2 | String | Maximum 40 characters | Optional | |
| 28 | Corporate Address line 3 | corpAddr3 | Corporate Address Line 3 | String | Maximum 40 characters | Optional | |
| 29 | Corporate Address line 4 | corpAddr4 | Corporate Address Line 4 | String | Maximum 40 characters | Optional | |
| 30 | Corporate Postal Code | corpPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If cardFlag = P, the field is required. |
| 31 | Country | homeCountry | Country | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 32 | State/Province | homeState | State/Province | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 33 | City | homeCity | City | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 34 | District | homeDistrict | District | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 35 | Street Name | homeStreetName | Street Name | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 36 | Building Name | homeBuildingName | Building Name | String | Maximum 6 characters | Optional | |
| 37 | House Number | homeHouseNo | House Number | String | Maximum 6 characters | Optional | |
| 38 | Postal Code | homePostalCode | Zip Code | String | Maximum 6 characters | Conditional | If cardFlag = P, the field is required. |
| 39 | Carrier | carrier | Carrier | String | Maximum 10 characters | Conditional | Thales requested the following informationFixed Value: REGULAR |
| 40 | Packaging | packaging | Packaging | String | Maximum 10 characters | Conditional | Packaging Option. If no inserts , please use “NOINS” |
| 41 | Dispatch | dispatch | DispatchIf 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 correctly | String | Maximum 10 characters | Conditional | For example:IESIES_BULK |
| 42 | Bulk Id | bulkId | Bulk IdBatch number starting from 01 for each calendar day | String | Maximum 10 characters | Conditional | For example: 01,02,03,04One batch cannot exceed 2000 cards |
| 43 | SLA | SLA | SLA | String | Maximum 10 characters | Conditional | SLA with card manufactory Values :D02 |
| 44 | Logo Front ID | logoFrontID | Logo Front ID | String | Maximum 32 characters | Conditional | If co-brand logos need to be printed on the card face |
| 45 | Bulk Recipient Name | bulkRecipient | Recipient Name | String | Maximum 60 characters | Conditional | |
| 46 | Bulk Contact Number | bulkContactNo | Contact information of Recipient Name | String | Maximum 20 characters | Conditional | |
| 47 | Country | bulkCountry | Country | String | Maximum 20 characters | Optional | ISO-3166 (A3 better)If cardFlag = P, the field is required. |
| 48 | State/Province | bulkState | State/Province | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 49 | City | bulkCity | City | String | Maximum 20 characters | Conditional | If cardFlag = P, the field is required. |
| 50 | Address line 1 | bulkAddr1 | Address Line 1 | String | Maximum 40 characters | Conditional | If cardFlag = P, the field is required. |
| 51 | Address line 2 | bulkAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 52 | Address line 3 | bulkAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 53 | Address line 4 | bulkAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 54 | Postal Code | bulkPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If cardFlag = P, the field is required. |
| 55 | Billing Address Country | billCountry | Country ISO-3166 (A3 better) | String | Maximum 20 characters | Conditional | |
| 56 | Billing Address State/Province | billState | State/Province | String | Maximum 20 characters | Conditional | |
| 57 | Billing Address City | billCity | City | String | Maximum 20 characters | Conditional | |
| 58 | Billing Address line 1 | billAddr1 | Address Line 1 | String | Maximum 40 characters | Conditional | If using AVS service , billing address is required |
| 59 | Billing Address line 2 | billAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 60 | Billing Address line 3 | billAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 61 | Billing Address line 4 | billAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 62 | Billing Postal Code | billPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If using AVS service , billing address is required |
| 63 | Card Expiry Date | expiryDate | Card Expiry Date | String | YYMM | Optional | |
| 64 | Card Emboss Name line 2 | cardEmbossName2 | Card Emboss Name line 2 | String | Maximum 26 characters | Optional | For emboss company name on card (physical card) |
Response:
| Response Header | Field Name | Description | Format | Length | M/O | Remark | |
|---|---|---|---|---|---|---|---|
| 1 | Card Application Number | cardApplyNo | Card Application Number | String | Maximum 16 characters | Required | |
| 2 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Required | |
| 3 | Corporate Id | corporateId | Corporate account id | String | Maximum 15 characters | Required | Corporate Id |
| 4 | Card Number | cardNumber | Card Number | String | Maximum 19 characters | Optional | |
| 5 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Required | |
| 6 | Card Expiry Date | expiryDate | Card Expiry Date | String | YYMM | Required |
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 Element | Field Name | Description | Format | Length | M/O | Remark | |
|---|---|---|---|---|---|---|---|
| 1 | Application Number | cardApplyNo | Card Application Number | String | Maximum 16 characters | Required | |
| 2 | Country | homeCountry | Country ISO-3166 (A3 better) | String | Maximum 20 characters | Optional | |
| 3 | State/Province | homeState | State/Province | String | Maximum 20 characters | Optional | |
| 4 | City | homeCity | City | String | Maximum 20 characters | Optional | |
| 5 | Address line 1 | homeAddr1 | Address Line 1 | String | Maximum 40 characters | Optional | |
| 6 | Address line 2 | homeAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 7 | Address line 3 | homeAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 8 | Address line 4 | homeAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 9 | Postal Code | homePostalCode | Zip Code | String | Maximum 9 characters | Optional | |
| 10 | Recipient Name | recipient | Recipient | String | Maximum 60 characters | Conditional | |
| 11 | Contact Number | contactNo | Contact information of Recipient | String | Maximum 20 characters | Conditional | |
| 12 | Bulk Recipient Name | bulkRecipient | Recipient Name | String | Maximum 60 characters | Conditional | |
| 13 | Bulk Contact Number | bulkContactNo | Contact information of Recipient Name | String | Maximum 20 characters | Conditional | |
| 14 | Billing Address Country | billCountry | Country ISO-3166 (A3 better) | String | Maximum 20 characters | Conditional | |
| 15 | Billing Address State/Province | billState | State/Province | String | Maximum 20 characters | Conditional | |
| 16 | Billing Address City | billCity | City | String | Maximum 20 characters | Conditional | |
| 17 | Billing Address line 1 | billAddr1 | Address Line 1 | String | Maximum 40 characters | Conditional | If using AVS service , billing address is required |
| 18 | Billing Address line 2 | billAddr2 | Address Line 2 | String | Maximum 40 characters | Optional | |
| 19 | Billing Address line 3 | billAddr3 | Address Line 3 | String | Maximum 40 characters | Optional | |
| 20 | Billing Address line 4 | billAddr4 | Address Line 4 | String | Maximum 40 characters | Optional | |
| 21 | Billing Postal Code | billPostalCode | Zip Code | String | Maximum 9 characters | Conditional | If using AVS service , billing address is required |
Response: None. Only response public header, please refer to the response code in header.