Card

Cardlnfolnquiry

This API is used to retrieve card-related information, including card product, status, delivery satus.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Required
2	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Required
3	Card Expiry Date	expiryDate	Card Expiry Date	String	YYMM	Required
4	Card Flag	cardFlag	V- Virtual/Nonphysical P- Physical	String	Maximum 1 character	Required
5	Card Product Code	cardProdCode	Card product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit Card	String	Maximum 4 characters	Required
6	Card Product Type	cardProdType	Card Product Type C-Credit Card D-Debit Card G-Gift Card P-Prepaid Card B-Business Card R-Corporate Card	String	Maximum 1 character	Required
7	Card Picture Code	cardPicCode	Card Picture Code	String	Maximum 15 characters	Optional
8	Card Open Date	openDate	Card Open Date	String	YYYYMMDD	Required
9	Card Status	cardStatus	The current status of the card. Valid Values: N: Normal U: Inactive; Unclaimed D: Cancellation; Destroyed B: Freeze Card	String	Maximum 1 character	Required
10	Card Block Status	blockStatus	The current status of the card. Valid Values: N: Normal B: Freeze Card	String	Maximum 1 character	Required
11	Status Modify User	statusModUser	If card Status is modified by an operator	String	Maximum 32 characters	Optional
12	Status Modify Date	statusModDate	Date of the last card status change	String	YYYYMMDD	Optional
13	Card Tracking Number	cardTrackingNumber	Card Tracking Number	String	Maximum 20 characters	Optional
14	Card Delivery Status	cardDeliveryStatus	Values: 1. RTS 2. DELIVERED 3. DAMAGED 4. For DISPSOITION 5. Cancelled 6. NO DATA FOUND ON SYSTEM 7. WITH CLIENT DISPOSITION 8. Complete	String	Maximum 20 characters	Optional
15	Card Delivery Remark	cardDeliveryRemark	Card Delivery Remark	String	Maximum 120 characters	Optional
16	CIF Number	customerId	Customer unique ID	String	Maximum 32 characters	Required
17	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 character	Required
18	Customer ID Number	custIdNo	Customer NRIC No.	String	Maximum 32 characters	Required
19	Customer Name	custName	Customer Name	String	Maximum 120 characters	Optional
20	Customer English Name	custEngName	Customer English Name	String	Maximum 140 characters	Optional
21	Customer Class	custClass	Customer Class	String	Maximum 4 characters	Optional
22	Customer Mobile Number	custMobile	Customer mobile number	String	Maximum 25 characters	Optional
23	Customer E-mail	custEmail	Customer E-mail	String	Maximum 60 characters	Optional
24	House Number	homeCountry	Country	String	Maximum 20 characters	Optional
25	Building Name	homeState	State/Province	String	Maximum 20 characters	Optional
26	Street Name	homeCity	City	String	Maximum 20 characters	Optional
27	District	homeDistrict	District	String	Maximum 20 characters	Optional
28	City	homeStreetName	Street Name	String	Maximum 20 characters	Optional
29	State	homeBuildingName	Building Name	String	Maximum 6 characters	Optional
30	Country	homeHouseNo	House Number	String	Maximum 6 characters	Optional
31	Zip Code	homePostalCode	Zip Code	String	Maximum 6 characters	Optional

CardActivation

This API is used to activate a payment card. By default, all newly created cards are inactive until this API is used to activate them.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Card Expiry Date	expiryDate	Card Expiry Date	String	YYMM	Required
4	CVV2	CVV2	CVV2	String	Maximum 3 characters	Required
5	Card Emboss Name	cardEmbossName	Card Emboss Name	String	Maximum 26 characters	Optional
6	CIF Number	customerId	Customer unique ID	String	Maximum 32 characters	Required
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 character	Required
8	Customer ID Number	custIdNo	Customer NRIC No.	String	Maximum 32 characters	Required
9	Customer E-mail	custEmail	Customer E-mail	String	Maximum 60 characters	Optional

Response:

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

CardReplacement

This API is used to used to replace a card with the same card number, a specific card number or a random number. It can also be used to convert a virtual card into a physical card.

Request：

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	New Card Number	newCardNumber	New Card Number	String	Maximum 19 characters	Optional
4	Card Flag	cardFlag	V- Virtual/Nonphysical P- Physical	String	Maximum 1 character	Required
5	Card Product Code	cardProdCode	Card Product Code ( Debit Card , Virtual Card , ....) 1000 - Debit Card 2000 - Credit Card	String	Maximum 4 characters	Required
6	Card Picture Code	cardPicCode	Card Picture Code	String	Maximum 15 characters	Optional
7	Card Emboss Name	cardEmbossName	Card Emboss Name	String	Maximum 26 characters	Optional
8	Reason Code	reasonCode	Reasons code to replace a card: 001-My Card information is leaked 002-There is a fraud transaction with my card 003-My card is damaged 004-I lost my card 999-Others	String	Maximum 3 characters	Required
9	Description of Other Reason	reasonDesc	Description of Other Reason	String	Maximum 30 characters	Optional
10	Card Replacement Fee Amount	feeAmount	Card Replacement Fee Amount	String	16,2	Optional
11	Card Replacement Waiver Indicator	feeWaiveInd	Values: 0- Waived 1- Charge	String	Maximum 1 character	Optional

Response：

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	New Card Number	newCardNumber	New Card Number	String	Maximum 19 characters	Required
2	New Card Token Number	newCardToken	New Card Token Number	String	Maximum 19 characters	Required
3	New Expiry Date	newExpiryDate	New Expiry Date	String	YYMM	Required
4	New CVV2	newCVV2	New CVV2	String	Maximum 3 characters	Required

CardCanecllation

This API is used to cancel a payment card with specific reason code.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Reason Code	reasonCode	Reasons code to replace a card: 001-My Card information is leaked 002-There is a fraud transaction with my card 003-My card is damaged 004-I lost my card 999-Others	String	Maximum 3 characters	Required
4	Description of Other Reason	reasonDesc	Description of Other Reason	String	Maximum 30 characters	Optional

Response:

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

CardStatusUpdate

This API is used to change the status of a payment card. The status of a card can be changed an unlimited number of times. Note: the only way to change the card status from “inactive” to “normal” is use CardActivation API.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Operate Flag	cardOptFlag	Value: B - Lost C - Unlost D - Block E - Unblock H - Pin Lost	String	Maximum 1 character	Required
4	Reason Code	reasonCode	Reasons code to replace a card: 001-My Card information is leaked 002-There is a fraud transaction with my card 003-My card is damaged 004-I lost my card 999-Others	String	Maximum 3 characters	Optional
5	Description of Other Reason	reasonDesc	Description of Other Reason	String	Maximum 30 characters	Optional

Response:

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

CardLimitSetting

This API is used to set card level limits, including transaction limits, domestic/worldwide and ecommerce/POS transaction indicators.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Card Operation Flag	cardOptFlag	Value: 0- retrieve limits 1- update limits	String	Maximum 1 character	Required
4	the name of business	businessName	atmWithdrawLocal - ATM Withdrawal - Local atmWithdrawInter - ATM Withdrawal - International inStoreLocal - In-Store Purchases - Local inStoreInter - In-Store Purchases – International eCommerce - E-commerce Payment	String	Maximum 30 characters	Optional	if operationFlag = 1 it is required
5	the switch of business	businessOnOff	the switch of business 0-off 1-on	String	Maximum 1 character	Optional	if operationFlag = 1 it is required
6	single limit amount of card limit for the business	singleLimitAmt	single limit amount of card limit for the business	String	16,2	Optional	if operationFlag = 1 it is required
7	the daily amount of card limit for the business	dailyLimitAmt	the daily amount of card limit for the business	String	16,2	Optional	if operationFlag = 1 it is required
8	the daily transactions of card limit for the business	dailyLimitCnt	the daily transactions of card limit for the business	String	8	Optional	if operationFlag = 1 it is required
9	the monthly amount of card limit for the business	monthlyLimitAmt	the monthly amount of card limit for the business	String	16,2	Optional	if operationFlag = 1 it is required
10	the monthly transactions of card limit for the business	monthlyLimitCnt	the monthly transactions of card limit for the business	String	8	Optional	if operationFlag = 1 it is required
11	the yearly amount of card limit for the business	yearlyLimitAmt	the yearly amount of card limit for the business	String	16,2	Optional	if operationFlag = 1 it is required
12	the yearly transactions of card limit for the business	yearlyLimitCnt	the yearly transactions of card limit for the business	String	8	Optional	if operationFlag = 1 it is required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Record Number	recordNum	Record Number	String	Maximum 8 characters	Required
2	Record List	recordList	each element is a complex element that includes the following sub-elements:
2.1	sub-elements of each element in the list	businessName	atmWithdrawLocal - ATM Withdrawal - Local atmWithdrawInter - ATM Withdrawal - International inStoreLocal - In-Store Purchases - Local inStoreInter - In-Store Purchases – International eCommerce - E-commerce Payment	String	Maximum 30 characters	Optional
2.2		businessOnOff	the switch of business 0-off 1-on	String	Maximum 1 character	Optional
2.3		singleLimitAmt	single limit amount of card limit for the business	String	16,2	Optional
2.4		dailyLimitAmt	the daily amount of card limit for the business	String	16,2	Optional
2.5		dailyLimitCnt	the daily transactions of card limit for the business	String	8	Optional
2.6		monthlyLimitAmt	the monthly amount of card limit for the business	String	16,2	Optional
2.7		monthlyLimitCnt	the monthly transactions of card limit for the business	String	8	Optional
2.8		yearlyLimitAmt	the yearly amount of card limit for the business	String	16,2	Optional
2.9		yearlyLimitCnt	the yearly transactions of card limit for the business	String	8	Optional

CardFaceInquiry

This API is used to retrieve card number、expiry date、CVV2 of the virtual card.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Required
3	Card Picture Code	cardPicCode	Card Picture Code	String	Maximum 15 characters	Required
4	Font Color	fontColor	Font Color	String	Maximum 11 characters	Required	Eg: 255,255,255

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Face Content	cardFaceContent	Card Face Content	Text		Required	a pdf file encode by base64

CVV2Inquiry

This API is used to retrieve the card verification value 2 of a given card.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Required
2	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Required
3	Card Expiry Date	expiryDate	Card Expiry Date	String	YYMM	Required
4	CVV2	CVV2	CVV2	String	Maximum 3 characters	Required

CVV2Verify

This API is used to verify the CVV2 of a given card.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Card Expiry Date	expiryDate	Card Expiry Date	String	YYMM	Required
4	CVV2	CVV2	CVV2	String	Maximum 3 characters	Required

Response:

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

GenerateDCVV

This API is used to generate the CVV2 of a given card.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Required
2	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Required
3	Card Expiry Date	expiryDate	Card ExpiryDate	String	YYMM	Required
4	CVV2	CVV2	CVV2	String	Maximum 3 characters	Required

CardExpiryDateUpdate

This API is used to update the expiry date of a given card.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional
3	Card Expiry Date	expiryDate	Card Expiry Date	String	YYMM	Required

Response:

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

CardSecureRegist

This API is used to register a given card with ACS service.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional	For 3D-Secure Service
2	Card Number	cardNumber	Card Number	String	Maximum 19 characters	Conditional

Response:

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